NF2#

NF2 is a Python framework for neural non-linear magnetic-field extrapolations in Cartesian and spherical geometries.

Start Here#

New users should begin with the installation guide, run the quickstart example, then choose the extrapolation geometry and training settings for their data.

  • Installation covers package installation and optional dependencies.

  • Quickstart walks through the shortest path from input data to an extrapolation.

  • Usage overview shows the command-line, Python, and notebook entry points.

Main Guides#

The main guides collect the common run and analysis pages into a shorter top-level menu.

  • Extrapolations groups Cartesian, spherical, analytical, and series runs.

  • Training explains losses, loss schedules, height scaling, batch sizes, validation resolution, and memory handling.

  • Evaluation groups export and quality-metric procedures.

  • FAQ answers recurring operational questions.

Reference Material#

Use the reference pages when you need exact configuration keys, command-line options, API signatures, or citation information.

  • Reference groups the API, YAML, dataset, CLI, and export references.

  • Publications lists method and application papers.

Contents