Skip to content

API Reference

This is a complete reference for all public APIs in JAFF.

Subpackages

  • Core

    Primary data-model classes: Network, Species, Reaction, Elements.

    jaff.core

  • Codegen

    Source code generation from reaction networks: Builder, Codegen, Preprocessor.

    jaff.codegen

  • Drivers

    I/O drivers for CSV, HDF5, SQLite, and TOML file formats.

    jaff.drivers

  • Physics

    Physical constants and photo cross-section lookup.

    jaff.physics

  • Plotting

    Publication-quality plots of rates and cross sections: plot_rates, plot_xsecs, Plotter.

    jaff.plotting

Module Overview

JAFF's public API is organized into five subpackages: core (network data model), codegen (source code generation), drivers (file I/O), physics (constants and photochemistry), and plotting (rate and cross-section plots).

classDiagram
    class core {
        Network
        Species
        Reaction
        Elements
    }
    class codegen {
        Builder
        Codegen
        Preprocessor
    }
    class drivers {
        csv
        HDF5
        Db / JaffDb
        Toml
    }
    class physics {
        constants
        Photochemistry
    }
    class plotting {
        plot_rates
        plot_xsecs
        Plotter
    }
    jaff --> core
    jaff --> codegen
    jaff --> drivers
    jaff --> physics
    jaff --> plotting