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.

Source Distribution

pysecs-0.2.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

pysecs-0.2.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file pysecs-0.2.0.tar.gz.

File metadata

  • Download URL: pysecs-0.2.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for pysecs-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f6f3be1b23904b2ea9e09864d8764a953e625217f1b150b4c7100835b6533245
MD5 982c5fca7086866feaaeeb138317b664
BLAKE2b-256 f10090d5909fc5a7db57a457393d8b60127c78e9cfaa700db48145d569046457

See more details on using hashes here.

File details

Details for the file pysecs-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pysecs-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for pysecs-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e31aeb93482e08a869e8f9dc072dccdcd238c0ee75832749cd179fe89ac78c0
MD5 70c208d3f3950bd41a86262b77fb6a8e
BLAKE2b-256 c0cf32f447b6793ab655d7405b33585c6d1f7330773f68462d699c0fdaf6104a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page