Python API

This reference describes the Python interface in Veris 0.2.1. The documentation build reads function signatures and docstrings from the code. Start with Getting started to install Veris and run a first simulation. Then use the pages below to look up individual objects and functions. The Scientific package hierarchy explains how the scientific packages are organized and where to import specialized functions.

Use Experiment definitions for definitions that cannot change in place and for input checks. Use Simulation lifecycle to control runs, output and restart from Python, and Integration to repeat model steps with JAX. Model data and metadata describes State, which holds model arrays, Diagnostics, which holds step results, and static numerical policy and dynamic physical parameter PyTrees. Import specialized functions from the modules shown in their entries.

• Model data and metadata
• Experiment definitions
• Simulation lifecycle
• Initialization and presets
• Integration
• Physics kernels
• Halos and parallel execution
• Input and output