pfsspy is a python package for carrying out Potential Field Source Surface modelling, a commonly used magnetic field model of the Sun and other stars.
Until pfsspy 1.0 is released, elements of the API are liable to change between versions. A full changelog that lists breaking changes, and how to adapt your code for them can be found at Changelog.
If you find any bugs or have any suggestions for improvement, please raise an issue here: https://github.com/dstansby/pfsspy/issues
pfsspy can be installed from PyPi using
pip install pfsspy
This will install pfsspy and all of its dependencies. In addition to the core dependencies, there are two optional dependencies (numba, streamtracer) that improve code performance. These can be installed with
pip install pfsspy[performance]
If you use pfsspy in work that results in publication, please cite the archived code at both
Citation details can be found at the lower right hand of each web page.