Reference/API

disco Package

Functions

trace_trajectory(config, particle_state, ...)

Calculate particle trajectories.

Classes

Axes(x, y, z, t, r_inner)	Coordinates of a Rectilinear Grid in SM Coordinates.
FieldModel(Bx, By, Bz, Ex, Ey, Ez, axes[, ...])	Magnetic and electric field models used to propagate particles.
DynamicFieldModelLoader(dataset, config, ...)	Wraps a FieldModelDataset to provide delayed loading of field models.
ParticleHistory(t, x, y, z, ppar, M, B, W, ...)	History of trajectory tracing.
ParticleState(x, y, z, ppar, ...)	Initial conditions of particles.
TraceConfig(t_final[, output_freq, ...])	Configuration for running the tracing code.

Class Inheritance Diagram

disco.readers Module

Classes to load field models from simulation output and files on disk.

Classes

FieldModelDataset()	This is an abstract base class to provide delayed loading for simulation output.
SwmfOutFieldModelDataset(glob_pattern[, t0, ...])	Subclass of FieldModelDataset for delayed reading of SWMF Output in .out Format.

Class Inheritance Diagram