Changelog¶

0.3.2¶

Fixed a bug in pfsspy.FieldLine.is_open, where some open field lines were incorrectly calculated to be closed.

Fixed a bug that incorrectly set closed line field polarities to -1 or 1 (instead of the correct value of zero).
FieldLine.footpoints has been removed in favour of the new pfsspy.FieldLine.solar_footpoint and pfsspy.FieldLine.source_surface_footpoint. These each return a single footpoint. For a closed field line, see the API docs for further details on this.
pfsspy.FieldLines has been added, as a convenience class to store a collection of field lines. This means convenience attributes such as pfsspy.FieldLines.source_surface_feet can be used, and their values are cached greatly speeding up repeated use.

The API for doing magnetic field tracing has changed. The new pfsspy.tracing module contains Tracer classes that are used to perform the tracing. Code needs to be changed from:
```
fline = output.trace(x0)
```
to:
```
tracer = pfsspy.tracing.PythonTracer()
tracer.trace(x0, output)
flines = tracer.xs
```
Additionally x0 can be a 2D array that contains multiple seed points to trace, taking advantage of the parallelism of some solvers.
The pfsspy.FieldLine class no longer inherits from SkyCoord, but the SkyCoord coordinates are now stored in pfsspy.FieldLine.coords attribute.
pfsspy.FieldLine.expansion_factor now returns np.nan instead of None if the field line is closed.
pfsspy.FieldLine now has a footpoints attribute that returns the footpoint(s) of the field line.

pfsspy.Input and pfsspy.Output now take the optional keyword argument dtime, which stores the datetime on which the magnetic field measurements were made. This is then propagated to the obstime attribute of computed field lines, allowing them to be transformed in to coordinate systems other than Carrignton frames.
pfsspy.FieldLine no longer overrrides the SkyCoord __init__; this should not matter to users, as FieldLine objects are constructed internally by calling pfsspy.Output.trace()

Output.plot_source_surface now accepts keyword arguments that are given to Matplotlib to control the plotting of the source surface.

Added more explanatory comments to the examples
Corrected the dipole solution calculation
Added pfsspy.coords.sph2cart() to transform from spherical to cartesian coordinates.

pfsspy.Output.plot_pil() now accepts keyword arguments that are given to Matplotlib to control the style of the contour.
pfsspy.FieldLine.expansion_factor is now cached, and is only calculated once if accessed multiple times.