API reference

pfsspy Package

Functions

load_output(file)	Load a saved output file.
pfss(input)	Compute PFSS model.

Classes

Input(br, nr, rss)	Input to PFSS modelling.
Output(alr, als, alp, grid[, input_map])	Output of PFSS modelling.

Class Inheritance Diagram

pfsspy.grid Module

Classes

Grid(ns, nphi, nr, rss)

Grid on which the pfsspy solution is calculated.

Class Inheritance Diagram

pfsspy.fieldline Module

Classes

ClosedFieldLines(field_lines)	A set of closed field lines.
FieldLine(x, y, z, output)	A single magnetic field line.
FieldLines(field_lines)	A collection of FieldLine.
OpenFieldLines(field_lines)	A set of open field lines.

Class Inheritance Diagram

pfsspy.tracing Module

Classes

FortranTracer([max_steps, step_size])	Tracer using Fortran code.
PythonTracer([atol, rtol])	Tracer using native python code.
Tracer()	Abstract base class for a streamline tracer.

Class Inheritance Diagram

pfsspy.utils Module

Functions

car_to_cea(m[, method])	Reproject a plate-carée map in to a cylindrical-equal-area map.
carr_cea_wcs_header(dtime, shape)	Create a Carrington WCS header for a Cylindrical Equal Area (CEA) projection.
is_car_map(m[, error])	Returns True if m is in a plate carée projeciton.
is_cea_map(m[, error])	Returns True if m is in a cylindrical equal area projeciton.
is_full_sun_synoptic_map(m[, error])	Returns True if m is a synoptic map spanning the solar surface.
load_adapt(adapt_path)	Parse adapt .fts file as a sunpy.map.MapSequence