NEOPAX.api

Direct Python API helpers for NEOPAX.

Classes

RunResult

Structured return object for direct API runs.

Functions

prepare_config(→ dict[str, Any])	Load and override a NEOPAX config without executing it.
_extract_final_state(raw_result)
_extract_result_field(raw_result, key[, default])
run(→ RunResult)	Convenience entry point for direct NEOPAX execution.

Module Contents

class NEOPAX.api.RunResult

Structured return object for direct API runs.

mode: str

config: dict[str, Any]

raw_result: Any

final_state: Any = None

saved_states: Any = None

time_grid: Any = None

saved_step_sizes: Any = None

accepted_mask: Any = None

failed_mask: Any = None

fail_codes: Any = None

n_steps: Any = None

done: Any = None

failed: Any = None

fail_code: Any = None

final_time: Any = None

rho: Any = None

output_dir: pathlib.Path | None = None

NEOPAX.api.prepare_config(config_or_path: dict[str, Any] | str | pathlib.Path, *, mode: str | None = None, device: str | None = None, vmec_file: str | None = None, boozer_file: str | None = None, n_radial: int | None = None, n_x: int | None = None, backend: str | None = None, dt: float | None = None, t_final: float | None = None, output_dir: str | None = None, set_values: list[str] | None = None) → dict[str, Any]

Load and override a NEOPAX config without executing it.

NEOPAX.api._extract_final_state(raw_result: Any)

NEOPAX.api._extract_result_field(raw_result: Any, key: str, default=None)

NEOPAX.api.run(config_or_path: dict[str, Any] | str | pathlib.Path, *, mode: str | None = None, device: str | None = None, vmec_file: str | None = None, boozer_file: str | None = None, n_radial: int | None = None, n_x: int | None = None, backend: str | None = None, dt: float | None = None, t_final: float | None = None, output_dir: str | None = None, set_values: list[str] | None = None) → RunResult

Convenience entry point for direct NEOPAX execution.

This keeps the Python API explicit and usable from scripts or larger JAX workflows, while sharing the same common override mapping as the CLI.