pysecs is an open source library for calculating Spherical Elementary Current Systems (SECS).
- Based upon the scikit-learn framework with
fit()
andpredict()
methods. - The only dependency is NumPy. It is built using fast broadcasting techniques to provide highly scalable calculations.
Examples can be found in examples/
The easiest method to install pysecs is with pip.
> pip install pysecs
For a source install you can follow these instructions:
-
Clone the git repository
> git clone https://github.com/greglucas/pysecs
-
Build and install the package
> python setup.py install
-
Testing The package has a test suite that can be run with pytest
> pytest
The code is released under an MIT license License described in LICENSE.md
This package has been developed from different publications. Please consider citing the papers that are relevant to the work you are doing if you are utilizing this code.
Amm, O. "Ionospheric Elementary Current Systems in Spherical Coordinates and Their Application."
Journal of geomagnestism and geoelectricity 49.7 (1997): 947-955. doi:10.5636/jgg.49.947
Amm, O., and A. Viljanen. "Ionospheric disturbance magnetic field continuation
from the ground to the ionosphere using spherical elementary current systems."
Earth, Planets and Space 51.6 (1999): 431-440. doi:10.1186/BF03352247