pfsspy is a python package for carrying out Potential Field Source Surface modelling. For more information on the actually PFSS calculation see this document.


pfsspy is a very new package, so elements of the API are liable to change with the first few releases. 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

Improving performance


pfsspy automatically detects an installation of numba, which compiles some of the numerical code to speed up pfss calculations. To enable this simply install numba and use pfsspy as normal.


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.

Code reference

For the main user-facing code and a changelog see

for usage examples see

for the helper modules (behind the scense!) see

and for a quick reference guide to synoptic map FITS conventions see

Indices and tables