Skip to content

Reference

  • API

    Every public module, class and function, generated from the docstrings: core, fields, operators, physics, losses, solve, metrics, diagnostics, bench, autotune, baselines, instances, viz and utils.

  • Command line

    nefi list · run · bench · bench-merge · diagnose · autotune · ablate · sweep with every option and worked examples.

  • Configuration files

    YAML layouts, the curriculum schema, --set overrides, smoke presets, plugins and what a run writes.

  • Changelog

    Notable changes, following Keep a Changelog.

  • Contributing

    Adding an operator, a field, a loss or an instance; testing and style rules.

  • License & citation

    MIT License, CAB Lab, Princeton University, and how to cite the papers.

The design document specifies the contracts every module builds against, and the paper → code mapping traces every equation of the papers to the code.