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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jarvisplot-1.3.0.tar.gz
Algorithm Hash digest
SHA256 dfca0a61445d0cc211a3b6f1663e3187a331a5959385e5733cc4b99d06a0cab9
MD5 9800d06d13e17e5f01496763d97599d3
BLAKE2b-256 79a3442ff04cfa44aede045547e900ce96139e7562228588b8ce213a0859d424

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for jarvisplot-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 192c599369f6dc1d6384c00cd9dcd140a62d6422fd9c75ef8a053665a0732c0e
MD5 25598c78831707e18fc46e4442cbd88b
BLAKE2b-256 64e707d43c12b107ba717c5a7dee381a25b8e867eb91abe54d8cb3d55a7bcdae

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