📌 Goal: Help a physicist write and run a scan YAML quickly.

What is Jarvis-HEP?

Jarvis-HEP is a Python framework designed for parameter scanning and workflow orchestration in high-energy physics, providing tools for installation, task YAML structure, samplers, calculators, and advanced orchestration methods. It includes a roadmap for users, related packages for plotting and orchestration, and support for reporting issues. All tools are released under the MIT license.

Quick Start

Installation: Installation
Overall: From 0 to 1: commen workflow in Jarvis-HEP
CLI basics: Command Line Tools
Eggbox: a mini black box example Eggbox: a minimal black box example

Core documentation

Task YAML Structure: Task YAML Structure — field-by-field reference for writing and editing a task card.
Samplers: Samplers — when to use each sampling method, what inputs it expects, and how it affects scan behavior.
Sampler variables schema: Scan Parameters (Sampler Variables Schema) — the variable-definition reference used by samplers, including supported distributions and required parameters.
Calculators: Calculators — how Jarvis wraps external programs, prepares inputs, runs commands, and reads outputs.
Libraries: Library dependencies — how Jarvis declares, prepares, and tracks external library bundles required before calculators or operas run.
Operas: Operas — in-process workflow tools and advanced orchestration patterns when you want to go beyond the basic external black-box mode.
Environment requirements: Environment Requirements — how Jarvis checks platforms, dependencies, and runtime prerequisites before a scan starts.
Symbolic expressions: Symbolic Expression — expressions used in mappings, derived variables, and likelihood definitions.
I/O formats: IO files — how Jarvis reads and writes JSON, text, structured files, and variable mappings.

Project Links

Feedback

If you encounter bugs or unclear behavior, please open an issue:

Jarvis-HEP Issues

License

All Jarvis-HEP tools are released under the MIT license.