Skip to content

API Reference

Beta API (Updated March 3, 2026)

API signatures and internal implementations are still evolving.

Runtime Logging

TRACE now emits runtime diagnostics via loguru across core workflows (profile fetch, tracer execution, plotting, and geomagnetic grid builds).

All module pages now follow the same format:

  1. Scope summary
  2. Key classes / methods
  3. Auto-generated API (mkdocstrings)
  4. Full source code (embedded)

Legend

Package Class Method / Function

Module Tree

hfpytrace
├── __init__
├── collision
├── geomag
├── homing
├── pharlap
├── plottrace
├── utils
├── model
│   ├── __init__
│   ├── dispersion
│   ├── rt1d
│   ├── rt2d
│   └── rt3d
└── density
    ├── __init__
    ├── gemini
    ├── gitm
    ├── iri
    ├── sami
    ├── waccm
    └── wamipe

hfpytrace Package

hfpytrace.model Subpackage

hfpytrace.density Subpackage