Jarvis-PLOT
Jarvis-PLOT 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.
Current package version: 1.4.2.
Installation
pip install JarvisPLOT
The PyPI / distribution name is JarvisPLOT (normalized wheel name: jarvisplot).
The product name remains Jarvis-PLOT.
The Python import package and entrypoint remain unchanged:
import jarvisplot
jplot path/to/config.yaml
If you have an older environment that still uses a historical package name, replace:
pip uninstall jarvisplot Jarvis-PLOT JarvisPLOT
pip install JarvisPLOT
Command-Line Usage
Human help uses the same fixed-column Rich panels as Jarvis-HEP V2 / Portal:
jplot -h
jplot validate -h
jplot man # manual index
jplot man workflow # topic page
Render (bare path — there is no jplot run):
jplot path/to/config.yaml
jplot path/to/config.yaml --rebuild-cache
Discover / judge (write YAML yourself in an editor):
jplot data describe samples.csv --json
jplot cap methods --json
jplot doctor plot.yaml --json
jplot man workflow --json # agent-structured manual
jplot config expand plot.yaml --figure p --write # type: → layers
Render a Jarvis-HEP flowchart scene JSON:
jplot flowchart path/to/scene.json
# optional output path:
jplot flowchart path/to/scene.json -o path/to/out.png
Library form:
from jarvisplot import render_flowchart, render_flowchart_file
Project Workdir and Cache
- You can set
project.workdirin YAML. - If
output.diris omitted, Jarvis-PLOT 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+ renderbin) 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.
Example: Dynesty Runplot
Jarvis-PLOT includes a reusable dynesty runplot format. With a dataset named
dynesty, the figure can use the built-in card without writing axes or layer
details:
DataSet:
- name: dynesty
path: path/to/dynesty_result.csv
type: csv
Figures:
- name: dynesty_logL_vs_logX
enable: true
style:
- a4paper_2x1
- dynesty_runplot
See docs/specs/DYNESTY_RUNPLOT.md for the default axes, KDE, scatter overlay,
and evidence summary behavior.
Notes
- Figures are saved automatically to the output paths defined in the YAML configuration.
- Common output formats include PNG and PDF (backend-dependent).
- Saved figures include file metadata such as
Creator: Jarvis-PLOT, powered by Jarvis-HEPandJarvis-PLOT version: X.Y.Z; the PNGDescriptionalso includes both fields for macOS Finder compatibility. - Jarvis-PLOT works in headless environments (SSH, batch jobs) without any GUI backend.
Requirements
Python
- Python ≥ 3.10 (tested on 3.10–3.13)
Required Packages
numpypandaspolarsmatplotlibpyyamljsonschemascipy— numerical utilitiesh5py— required for loading HDF5 data filesshapelysympylogurudeepmergeJarvis-Operas>=1.1.4
Github Page
https://github.com/Pengxuan-Zhu-Phys/Jarvis-PLOT
Documentation
https://pengxuan-zhu-phys.github.io/Jarvis-Docs/
Repository Docs
Tracked project docs live in docs/.
docs/README.md- repo doc indexdocs/context/JARVIS_PLOT_CONTEXT.md- primary Codex-facing boundary docdocs/context/CODE_MAP_JARVIS_PLOT.md- concrete code owner mapdocs/context/JARVIS_PLOT_FRAMEWORK_LOGIC.md- runtime execution contractdocs/roadmap/IMPLEMENTATION_ROADMAP.md- active backlog and future work listdocs/specs/AGENT_DATA_API.md- planned agent bridge (spec only)docs/dev/DEVELOPER_RULES.md- current pipeline and cache rulesdocs/dev/MEMORY_OPTIMIZATION_GUIDE.md- narrow-table memory notes
Read the context docs and roadmap before changing parsing, transforms, rendering, or layout-related behavior.
License
MIT License
Metadata
Release files for JarvisPLOT 2.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| jarvisplot-2.0.6.tar.gz | 3.6 MB | Without provenance | Details for jarvisplot-2.0.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| jarvisplot-2.0.6-py3-none-any.whl | Python 3 | none | any | Details for jarvisplot-2.0.6-py3-none-any.whl |
Total release size: 7.2 MB
Release files / jarvisplot-2.0.6.tar.gz
| Download URL | jarvisplot-2.0.6.tar.gz |
|---|---|
| Size | 3.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e13f7dcc3fb3a2bc2900345954699b4bab2e2f1749fa49d0bf04e8289da026de
|
|
BLAKE2b-256 checksum How to use checksums |
10ff65d3285916f0ce6c0f0d2416cb2595f70221e329c280689050d45e1dfa33
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.13
|
Release files / jarvisplot-2.0.6-py3-none-any.whl
| Download URL | jarvisplot-2.0.6-py3-none-any.whl |
|---|---|
| Size | 3.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cd0df409f74158ee72e0657d9bd6554089e82218cdcd8553bbcc7ca93c8d2517
|
|
BLAKE2b-256 checksum How to use checksums |
18ce0066b12b5ce7c369b45843f32f3c9740e6ad4ba54867fa3313c3de2fc322
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.13
|
Security for JarvisPLOT 2.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.