Metadata-Version: 1.1
Name: pysecs
Version: 0.0.4
Summary: Spherical Elementary Current System Calculations
Home-page: https://github.com/greglucas/pysecs
Author: Greg Lucas
Author-email: greg.m.lucas@gmail.com
License: MIT
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
        
        Example notebooks can be found in [notebooks/](./notebooks/)
        
        ## Install
        
        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
        
        - [Report an issue using the GitHub issue tracker](http://github.com/greglucas/pysecs/issues)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
