get_tsyganenko¶
- rbinvariantslib.models.get_tsyganenko(model_name, params, time, x_re_sm_grid, y_re_sm_grid, z_re_sm_grid, inner_boundary, external_field_only=False) MagneticFieldModel¶
Helper function to get one of the tsyganenko fields on an LFM grid.
- Parameters:
- model_name{‘T96’, ‘TS05’}
Name of the magnetic field model to use.
- paramsdictionary of string to array
Input parameters to the Tsyganenko model. Keys are at minimum: “Pdyn”, “SymH”, “By” and “Bz”. For the TS05 model, optional keys are “W1” through “W6”.
- timedatetime, no timezone
Time to support the Tsyganenko magnetic field model
- x_re_sm_gridarray of shape (m, n, p)
x coordinates
- y_re_sm_gridarray of shape (m, n, p)
y coordinates
- z_re_sm_gridarray of shape (m, n, p)
z coordinates
- inner_boundaryfloat
Inner boundary of model
- Returns:
- model
MagneticFieldModel Magnetic model on LFM grid with dipole field values. Grid is in units of Re and magnetic field is is units of Gauss.
- model
