Network

jaff.core.network.Network

The Network class is the most important class in JAFF. It reads a reaction network file, auto-detects its format, validates mass and charge conservation, and assembles the full species and reaction catalogues along with stoichiometry matrices. It also handles optional radiation transport, photochemistry cross-sections, and auxiliary function files.

Constructor

Network(fname, config=None, errors=False, label=None, funcfile=True, replace_nH=True, rad_bands=[], rad_powerlaw_index=0, rad_energy_density=False, c=constants.c.cgs.value)

Parameters

fname : str or Path

Path to a network file, or the name of a built-in network (a sub-directory of networks/ containing a single .jet file). A built-in network name wins over a same-named path on disk. Supported formats: KIDA, UDFA, PRIZMO, KROME, UCLCHEM, a combination of the above and the .jaff file (Refer to to_jaff for more details).

config : str, Path, or None, optional

Path to a TOML configuration file. When None (default), JAFF looks for jaff.toml in the network file's directory.

errors : bool, optional

Exit on validation errors. Default False.

label : str or None, optional

Network identifier. Defaults to the file stem.

funcfile : bool, str, or Path, optional

Path to .jfunc auxiliary functions file. True (default) scans the network directory; False skips.

replace_nH : bool, optional

Replace nH/nHe symbols with species density sums. Default True.

rad_bands : list, optional

Radiation band boundaries enabling radiation transport. Default [].

rad_powerlaw_index : int or float, optional

Spectral power-law index. Default 0.

rad_energy_density : bool, optional

Interpret radiation as energy density. Default False.

c : float, optional

Speed of light in CGS. Default constants.c.cgs.value.

Raises

FileNotFoundError

If fname does not exist.

Attributes