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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: jarvisplot-1.0.12.tar.gz
  • Upload date:
  • Size: 763.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.0.12.tar.gz
Algorithm Hash digest
SHA256 4517b323efbf819f0640ee7a73a4727c8ab1f59be1ab52ef28dc372c9dd91968
MD5 569ca8ce5147d7320fd66407b8e7985e
BLAKE2b-256 4cfd5c8d4a64af8ada0dd15acad33d1b693f4fcb1fb6fbc33e340640e4461d2e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jarvisplot-1.0.12-py3-none-any.whl
  • Upload date:
  • Size: 774.4 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.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 b2ec625fb5df7a4d4fbdc412c3be6c883982651a40b03b78e2eb77a2afca711d
MD5 a3309d48ed43e4592d1af5681387d9ad
BLAKE2b-256 d46f5cd07a107404836fb6045abbf3a67c36bf9aa0c845834967988363c328ac

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