Getting started

Installation

To use NEOPAX, there is no need to install it. You can simply clone the repository and install it using the following command:

$ git clone https://github.com/uwplasma/NEOPAX.git
$ cd NEOPAX
$ pip install .

Run an example

To run the one of the examples, use the following command:

python examples/Calculate_Fluxes/Fluxes_Calculation.py

More examples are in subfolders of the examples folder.

CLI and API entry paths

After installation, NEOPAX can be run through either the console-script path, the module path, or the direct Python API.

Console script:

NEOPAX examples/Solve_Transport_Equations/Solve_Transport_equations_noHe_theta.toml

Module path:

python -m NEOPAX examples/Solve_Transport_Equations/Solve_Transport_equations_noHe_theta.toml

Direct Python API:

import NEOPAX

config = NEOPAX.load_config("examples/Solve_Transport_Equations/Solve_Transport_equations_noHe_theta.toml")
result = NEOPAX.run_config(config)

The direct Python API is the preferred entry path when NEOPAX is used inside a larger JAX workflow or when preserving a programmatic/autodiff-friendly call path matters.

For a more complete description of:

• CLI overrides

• NEOPAX.run(...)

• NEOPAX.prepare_config(...)

• NEOPAX.run_config(...)

• and recommended usage patterns

see Methods of Use.

For configuration details and example-driven walkthroughs, see also:

• Input File Reference

• Worked Examples

• Custom Flux And Source Models

If you want to add your own transport flux or source models, NEOPAX also supports Python-side registration and TOML-driven extension loading through an [extensions] section. See Custom Flux And Source Models.