# API reference

Generated from the NumPy-style docstrings in `src/tracmass`. Every
public module, class and function with a docstring is included; private
helpers (names starting with `_`) are left out.

```{eval-rst}
.. automodule:: tracmass
   :no-members:
```

## Top-level functions

```{eval-rst}
.. currentmodule:: tracmass

.. autosummary::
   :toctree: generated
   :nosignatures:

   run
   new_grid
   new_flux
   update_flux
   swap_fields
   steady_state
   time_dependent
   time_dependent_patched
   time_dependent_streaming
   load
   write_trajectories_parquet
   set_verbose
   free_device_memory
```

## Classes

```{eval-rst}
.. currentmodule:: tracmass

.. autosummary::
   :toctree: generated
   :nosignatures:

   ParticleState
   GridFields
   LazyFluxFields
   FluxFields
   ParticleRecorder
   RunMonitor
```

## Reason codes

`REASON_ACTIVE` (0), `REASON_TIME` (1), `REASON_LAND` (2),
`REASON_BOUNDS_H` (3), `REASON_PROGRESS` (4), `REASON_SLOW` (5),
`REASON_ITERLIMIT` (6), `REASON_DXYZ` (7), `REASON_BOUNDS_V` (8). See
[Stopping trajectories](../tutorials/stopping.md#reason-codes).

## Modules

```{toctree}
:maxdepth: 1

seed
gcm
adapters
integrate
advection_scheme
config
runsetup
output
seagrid
trajs
```