Skip to main content

JarvisPLOT: YAML-driven plotting engine

Project description

JarvisPLOT

JarvisPLOT is a lightweight, Python/Matplotlib-based plotting framework developed for Jarvis-HEP,
but it can also be used as a standalone scientific plotting tool.

It provides a simple command-line interface (CLI) to generate publication-quality figures from YAML configuration files, with most layout and style decisions handled by predefined profiles and style cards.


Installation

pip install jarvisplot

Command-Line Usage

Display help information:

jplot -h

Run JarvisPLOT with one or more YAML configuration files:

jplot path/to/config.yaml

Rebuild local cache for the current project workdir:

jplot path/to/config.yaml --rebuild-cache

Project Workdir and Cache

  • You can set project.workdir in YAML.
  • If output.dir is omitted, JarvisPLOT now defaults to <workdir>/plots/.
  • Data cache is stored in <workdir>/.cache/.
  • Profiling pipelines are prebuilt once and reused from cache when source fingerprint and profile settings are unchanged.
  • Profiling uses a fast two-stage grid reduction (pregrid + render bin) for large datasets.

Example: SUSYRun2 Ternary Plots

jplot ./bin/SUSYRun2_EWMSSM.yaml
jplot ./bin/SUSYRun2_GEWMSSM.yaml

Note: The data file paths inside the YAML files must be updated to match your local setup.


Notes

  • Figures are saved automatically to the output paths defined in the YAML configuration.
  • Common output formats include PNG and PDF (backend-dependent).
  • JarvisPLOT works in headless environments (SSH, batch jobs) without any GUI backend.

Requirements

Python

  • Python ≥ 3.10 (tested on 3.10–3.13)

Required Packages

  • numpy
  • pandas
  • matplotlib
  • pyyaml
  • jsonschema
  • scipy — numerical utilities
  • h5py — required for loading HDF5 data files
  • shapely
  • scipy
  • sympy

Github Page

https://github.com/Pengxuan-Zhu-Phys/Jarvis-PLOT

Documentation

https://pengxuan-zhu-phys.github.io/Jarvis-Docs/


License

MIT License

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

jarvisplot-1.2.0.tar.gz (780.4 kB view details)

Uploaded Source

Built Distribution

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

jarvisplot-1.2.0-py3-none-any.whl (792.1 kB view details)

Uploaded Python 3

File details

Details for the file jarvisplot-1.2.0.tar.gz.

File metadata

  • Download URL: jarvisplot-1.2.0.tar.gz
  • Upload date:
  • Size: 780.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for jarvisplot-1.2.0.tar.gz
Algorithm Hash digest
SHA256 074506dbee197b7e41fddc1e93e11ebe2a480de17576774e9cedfba8017d31fe
MD5 9f126904934eed7980c7c13e48fa1690
BLAKE2b-256 15aa0d9ff90555d05b96135f8b5d5586b1559be63292d8419863c1348e1f1989

See more details on using hashes here.

File details

Details for the file jarvisplot-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: jarvisplot-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 792.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for jarvisplot-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 97273e801f5c021fbdf5f137f3e99fc9d8fb851b08553940b55852131d37bac8
MD5 27774e13afb9f390924324b258c5dcc4
BLAKE2b-256 c812cb15cf579fcfeb89eae51ec2df0d18034cc5b3caecb6b362899103d2fc5d

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