API reference¶

This section is generated from the Python docstrings of the neoVULCAN modules. For a narrative overview of the codebase, see Code architecture.

Note

Many modules depend on the auto-generated chemistry_jax.py which in turn imports JAX. If JAX is not installed in the documentation build environment, the affected modules are mocked through autodoc_mock_imports in conf.py; the documented signatures are still correct.

Library entry point¶

Configuration schema and runtime¶

Data containers¶

Atmosphere and initial conditions¶

Reaction rates and photochemistry setup¶

Chemistry kernel and Jacobian¶

ODE solver¶

Integration driver¶

Radiative transfer¶

Condensation¶

Output and I/O¶