get_swmf_out_model¶
- rbinvariantslib.models.get_swmf_out_model(path, xaxis=None, yaxis=None, zaxis=None, interp_radius=1)¶
Get a
MagneticFieldModelfrom SWMF .out output. This regrids it to a rectilinear grid each time this function is called.- Parameters:
- pathstr
Path to SWMF file in .out format
- xaxis: array
x-axis of rectilinear grid (default -10:.15:10)
- yaxis: array
y-axis of rectilinear grid (default -10:.15:10)
- zaxis: array
z-axis of rectilinear grid (default -5:.15:5)
- interp_radiusfloat
Radius to use for interpolation. Default is 1 Re.
- Returns:
- model
MagneticFieldModel Data on rectilinear grid with SWMF magnetic field values. Grid is in units of Re and magnetic field is is units of Gauss
- model