Metadata-Version: 2.1
Name: icplot
Version: 0.0.12
Summary: Utilities for generating plots and graphics for technical reports.
Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icplot
Project-URL: Homepage, https://git.ichec.ie/performance/toolshed/icplot
Keywords: Publishing,Technical Reports,Graphics
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: wand
Requires-Dist: matplotlib
Requires-Dist: iccore==0.1.5
Provides-Extra: cairo
Requires-Dist: pycairo; extra == "cairo"
Requires-Dist: CairoSVG; extra == "cairo"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-sugar; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: mypy; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: pylint; extra == "test"

# icplot

This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.

# Installation #

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

``` shell
pip install icplot
```

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

``` shell
brew install imagemagick cairo
```

# Features #

The project has support for:

* Coverting image formats between pdf, svg and png
* Building pdf output from tex files, including tikz.

There is a command line interface included, mainly for testing, which may be heplful in getting to know available features.

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
```

# 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.

