Skip to main content

Utilities for generating plots and graphics for technical reports.

Project description

icplot

This is a library used at The Irish Centre for High End Computing (ICHEC) 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:

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

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

icplot convert --source my_tikz.tex

To render a Mermaid plot as png you can do:

icplot convert --source my_mermaid.mmd

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

icplot plot --config my_plot.yml

Installation

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

pip install icplot

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

icplot-0.1.5.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

icplot-0.1.5-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

Details for the file icplot-0.1.5.tar.gz.

File metadata

  • Download URL: icplot-0.1.5.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for icplot-0.1.5.tar.gz
Algorithm Hash digest
SHA256 33c38dc8a23f8c36e6614dea0c9ff49deb6a37003784a2ce2536b611f7a31d2a
MD5 1bd9c8d3a9deee95b560be5e6219b061
BLAKE2b-256 dcb2d53b639ce92029d63a0b003efa0757b73d93ef62e81826ad757fcf0ffa45

See more details on using hashes here.

File details

Details for the file icplot-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: icplot-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 27.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for icplot-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 22b789ba70c9db8a0ac2816fe28394a9e1a4aff687d381e5bbf871d13f9df452
MD5 99b91b2f551dfa7a68cd04e4a5b6f284
BLAKE2b-256 27995c13f0ea6c48d6a4e5f9a050770419a0397234e917584fac5b8e06b42467

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page