icplot


Nameicplot JSON
Version 0.2.4 PyPI version JSON
download
home_pageNone
SummaryUtilities for generating plots and graphics for technical reports.
upload_time2025-08-13 16:27:59
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords publishing technical reports graphics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # icplot

This is a library used at [The Irish Centre for High End Computing (ICHEC)](https://www.ichec.ie) for generating plots and graphics for technical documents.

# Features #

The project has support for:

* Coverting image formats between pdf, svg and png
* Building pdf and png output from tex files, including tikz.
* Generating plots based on a serializable data model to support reproducible research
* Generating mermaid plots

To covert between image formats you can do:

``` shell
icplot convert --source my_image.svg --target my_image.png
```

To render a Tex tikz image as pdf and png you can do:

``` shell
icplot convert --source my_tikz.tex
```

To render a Mermaid plot as png you can do:

``` shell
icplot convert --source my_mermaid.mmd
```

To generate a plot or collection of plots from a yaml description you can do:

``` shell
icplot plot --config my_plot.yml
```

# Installation #

The package is available on PyPI. For a minimal installation you can do:

``` shell
pip install icplot
```

For full functionality, particularly conversion of image formats, `imagemagick` and `cairo` are required. On Mac you can install them with:

``` shell
brew install imagemagick cairo
```

# Copyright #

Copyright 2024 Irish Centre for High End Computing

The software in this repository can be used under the conditions of the GPLv3+ license, which is available for reading in the accompanying LICENSE file.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "icplot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "Publishing, Technical Reports, Graphics",
    "author": null,
    "author_email": "\"James Grogan, Irish Centre for High End Computing\" <james.grogan@ichec.ie>",
    "download_url": "https://files.pythonhosted.org/packages/1d/05/f6524e33c97a52ad129d592f6326dc84db3032ecae074ef4be2939287661/icplot-0.2.4.tar.gz",
    "platform": null,
    "description": "# icplot\n\nThis is a library used at [The Irish Centre for High End Computing (ICHEC)](https://www.ichec.ie) for generating plots and graphics for technical documents.\n\n# Features #\n\nThe project has support for:\n\n* Coverting image formats between pdf, svg and png\n* Building pdf and png output from tex files, including tikz.\n* Generating plots based on a serializable data model to support reproducible research\n* Generating mermaid plots\n\nTo covert between image formats you can do:\n\n``` shell\nicplot convert --source my_image.svg --target my_image.png\n```\n\nTo render a Tex tikz image as pdf and png you can do:\n\n``` shell\nicplot convert --source my_tikz.tex\n```\n\nTo render a Mermaid plot as png you can do:\n\n``` shell\nicplot convert --source my_mermaid.mmd\n```\n\nTo generate a plot or collection of plots from a yaml description you can do:\n\n``` shell\nicplot plot --config my_plot.yml\n```\n\n# Installation #\n\nThe package is available on PyPI. For a minimal installation you can do:\n\n``` shell\npip install icplot\n```\n\nFor full functionality, particularly conversion of image formats, `imagemagick` and `cairo` are required. On Mac you can install them with:\n\n``` shell\nbrew install imagemagick cairo\n```\n\n# Copyright #\n\nCopyright 2024 Irish Centre for High End Computing\n\nThe software in this repository can be used under the conditions of the GPLv3+ license, which is available for reading in the accompanying LICENSE file.\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Utilities for generating plots and graphics for technical reports.",
    "version": "0.2.4",
    "project_urls": {
        "Homepage": "https://git.ichec.ie/performance/toolshed/icplot",
        "Repository": "https://git.ichec.ie/performance/toolshed/icplot"
    },
    "split_keywords": [
        "publishing",
        " technical reports",
        " graphics"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b9f05a927af8d33fbdc7ff458edde5bed1e83991dc9a6721eb2c072519d0ee60",
                "md5": "6620ffc58ef54e4fff22d9e85e19192e",
                "sha256": "55b8ee933a395f15955d3c87c50c64d32ccfac6d302e90fe485eb841d45cdbdf"
            },
            "downloads": -1,
            "filename": "icplot-0.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6620ffc58ef54e4fff22d9e85e19192e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 49836,
            "upload_time": "2025-08-13T16:27:57",
            "upload_time_iso_8601": "2025-08-13T16:27:57.646734Z",
            "url": "https://files.pythonhosted.org/packages/b9/f0/5a927af8d33fbdc7ff458edde5bed1e83991dc9a6721eb2c072519d0ee60/icplot-0.2.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1d05f6524e33c97a52ad129d592f6326dc84db3032ecae074ef4be2939287661",
                "md5": "d6efc16f118c456642a06b88083e14dc",
                "sha256": "b8e7720e3beacdea4dae0b99a50db2550fe1a20f7be157a355dcc665958bc77c"
            },
            "downloads": -1,
            "filename": "icplot-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "d6efc16f118c456642a06b88083e14dc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 45147,
            "upload_time": "2025-08-13T16:27:59",
            "upload_time_iso_8601": "2025-08-13T16:27:59.035410Z",
            "url": "https://files.pythonhosted.org/packages/1d/05/f6524e33c97a52ad129d592f6326dc84db3032ecae074ef4be2939287661/icplot-0.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-13 16:27:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "icplot"
}
        
Elapsed time: 0.43772s