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

Uploaded Python 3

File details

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

File metadata

  • Download URL: jarvisplot-1.2.5.tar.gz
  • Upload date:
  • Size: 784.3 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.5.tar.gz
Algorithm Hash digest
SHA256 3f47e928a7e0d3cfabcf19d8fbfdfe132a63a032587b203926ecab973ab533d7
MD5 e43b4c2c75c24efc9bf8ffc7be7cd63b
BLAKE2b-256 8820ed9f91cf8e6834c971ec816177257771a0a53887b7bce3e939f1a7917d10

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jarvisplot-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 795.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f7e1c1d06e8870bb509e1ee7beab5b5e56417f77e04947af9b525000649bf506
MD5 de8af753cd861d7aa11f3796fff2821d
BLAKE2b-256 5e68fedfa374840eaedb1ea0d143b3bf87beccd8f2cb7634ab5b16f5e40d31ec

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