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

Uploaded Python 3

File details

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

File metadata

  • Download URL: icplot-0.1.7.tar.gz
  • Upload date:
  • Size: 35.0 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.7.tar.gz
Algorithm Hash digest
SHA256 466cc6650f1047baf6e2fc768a18c40e815d79f10223d97c412988e809a34c41
MD5 f33f88d55415a3919164ba6f22f1750f
BLAKE2b-256 8e8b3aeb695c56c80a63b3322687f47ce20a5c47934dd92b9fc9a43f75e9c6d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: icplot-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 37.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9ea8788f16c05bad10c5b3aa25ff716d6c0727bda5a46d4c8f8246b3aab2ff4e
MD5 81e407fba015397dde258f6cc6b356dd
BLAKE2b-256 2c29975b2a6228b655344e6a8068dbe460095d7508b719b2f5241f58ff687dc0

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