Skip to main content

Spherical Elementary Current System Calculations

Project description

# pysecs

pysecs is an open source library for calculating Spherical Elementary Current Systems (SECS).

## Features

  • Based upon the [scikit-learn](http://scikit-learn.org/) framework with fit() and predict() methods.
  • The only dependency is [NumPy](http://www.numpy.org/). It is built using fast broadcasting techniques to provide highly scalable calculations.

## Examples

Examples can be found in [examples/](./examples/)

## Install

The easiest method to install pysecs is with pip.

`bash > pip install pysecs `

For a source install you can follow these instructions:

  1. Clone the git repository

    `bash > git clone https://github.com/greglucas/pysecs `

  2. Build and install the package

    `bash > python setup.py install `

3. Testing The package has a test suite that can be run with pytest

`python > pytest `

## License

The code is released under an MIT license [License described in LICENSE.md](./LICENSE.md)

## References

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.

### [Original Paper](https://doi.org/10.5636/jgg.49.947)

`bibtex 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 `

### [Applications Paper](https://doi.org/10.1186/BF03352247)

`bibtex 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 `

## Problems or Questions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pysecs, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size pysecs-0.1.1-py3-none-any.whl (7.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pysecs-0.1.1.tar.gz (9.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page