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.6.tar.gz (31.8 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.6-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for icplot-0.1.6.tar.gz
Algorithm Hash digest
SHA256 dcee1f16f6fa45ae99c3f6f84ad8ed0b84cb93a6a3e19826612c5de6b9a3beb0
MD5 fd5bce074970568b924257d551a1fe36
BLAKE2b-256 78540de93586c4d777f58b4ca7c74f1de908a7022ef0c9904f8340272d78df25

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for icplot-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 32324a3273f0375e638363231ffb19ff2c1cbdf0ec295e366f1680fc84274e17
MD5 f565e17c5fc79585fd58bb4bce8051d5
BLAKE2b-256 4a02e6590a341ea83ca90836c7e376ca154f5197c7ba5e5366d5ae53779bb538

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