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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jarvisplot-1.1.2.tar.gz
Algorithm Hash digest
SHA256 250fa6ef8e521644594aab12786e1e85f4d51f175e27b6c70310c15e383690a2
MD5 ac93e5977eea434b701c998dac273a04
BLAKE2b-256 afc20f700a69b85992c073f9bcc3794151447166e8993b878ac1e7d513b97496

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jarvisplot-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 783.8 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.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d9e5dc7afa04e38c02bd4d2c5c3594c917799eef4f03b1e4878f7fa8013442bb
MD5 614bc453ff29d4f50d3a0330d9c0759e
BLAKE2b-256 ac116ef86a2c2146e7916b0ca87231c98c18416ac0edeeeb89cfd59a4367bba4

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