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

Note

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

Installing

pfsspy can be installed from PyPi using

pip install pfsspy

Code reference

For the main user-facing code see

• pfsspy Package
  • Functions
  • Classes

for usage examples see

• pfsspy examples

and for the helper modules (behind the scense!) see

• Helper modules
  • pfsspy.plot Module
  • pfsspy.coords Module

Indices and tables

• Index
• Module Index
• Search Page