pysecs

Name	pysecs JSON
Version	0.3.0 JSON
	download
home_page	None
Summary	Spherical Elementary Current System (SECS) Calculations.
upload_time	2024-12-18 04:23:34
maintainer	None
docs_url	None
author	None
requires_python	>=3.10
license	Copyright (c) 2018 Greg Lucas Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	spherical elementary current systems secs ionosphere atmosphere geomagnetic
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

- [Report an issue using the GitHub issue tracker](http://github.com/greglucas/pysecs/issues)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pysecs",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "Spherical Elementary Current Systems, SECS, Ionosphere, Atmosphere, Geomagnetic",
    "author": null,
    "author_email": "Greg Lucas <greg.m.lucas@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/88/17/c2dddf05abf6d4d1c0180a6333f6ee9ca4667607cd5a9569959bec0a24d2/pysecs-0.3.0.tar.gz",
    "platform": null,
    "description": "# pysecs\n\npysecs is an open source library for calculating Spherical Elementary Current Systems (SECS).\n\n## Features\n\n- Based upon the [scikit-learn](http://scikit-learn.org/) framework with `fit()` and `predict()` methods.\n- The only dependency is [NumPy](http://www.numpy.org/). It is built using fast broadcasting techniques to provide highly scalable calculations.\n\n## Examples\n\nExamples can be found in [examples/](./examples/)\n\n## Install\n\nThe easiest method to install pysecs is with pip.\n\n```bash\n> pip install pysecs\n```\n\nFor a source install you can follow these instructions:\n\n1. Clone the git repository\n\n    ```bash\n    > git clone https://github.com/greglucas/pysecs\n    ```\n\n2. Build and install the package\n\n    ```bash\n    > python setup.py install\n    ```\n\n3. Testing\nThe package has a test suite that can be run with pytest\n\n    ```python\n    > pytest\n    ```\n\n## License\n\nThe code is released under an MIT license\n[License described in LICENSE.md](./LICENSE.md)\n\n## References\n\nThis package has been developed from different publications. Please consider citing the papers\nthat are relevant to the work you are doing if you are utilizing this code.\n\n### [Original Paper](https://doi.org/10.5636/jgg.49.947)\n\n```bibtex\nAmm, O. \"Ionospheric Elementary Current Systems in Spherical Coordinates and Their Application.\"\nJournal of geomagnestism and geoelectricity 49.7 (1997): 947-955. doi:10.5636/jgg.49.947\n```\n\n### [Applications Paper](https://doi.org/10.1186/BF03352247)\n\n```bibtex\nAmm, O., and A. Viljanen. \"Ionospheric disturbance magnetic field continuation\nfrom the ground to the ionosphere using spherical elementary current systems.\"\nEarth, Planets and Space 51.6 (1999): 431-440. doi:10.1186/BF03352247\n```\n\n## Problems or Questions\n\n- [Report an issue using the GitHub issue tracker](http://github.com/greglucas/pysecs/issues)\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2018 Greg Lucas  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Spherical Elementary Current System (SECS) Calculations.",
    "version": "0.3.0",
    "project_urls": {
        "homepage": "https://greglucas.github.io/pysecs/",
        "repository": "https://github.com/greglucas/pysecs"
    },
    "split_keywords": [
        "spherical elementary current systems",
        " secs",
        " ionosphere",
        " atmosphere",
        " geomagnetic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52d20f2b0f6e2ee55d850d9439171fa7608b2734a22100e65dd1b194339c8f8d",
                "md5": "6f02e876dea5dc521a1b607dff0c8876",
                "sha256": "e9570ca10d691a49a3cd1cbc26116fa6bf7031a5df0e21071bcf8f5badc04530"
            },
            "downloads": -1,
            "filename": "pysecs-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6f02e876dea5dc521a1b607dff0c8876",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 9170,
            "upload_time": "2024-12-18T04:23:32",
            "upload_time_iso_8601": "2024-12-18T04:23:32.183537Z",
            "url": "https://files.pythonhosted.org/packages/52/d2/0f2b0f6e2ee55d850d9439171fa7608b2734a22100e65dd1b194339c8f8d/pysecs-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8817c2dddf05abf6d4d1c0180a6333f6ee9ca4667607cd5a9569959bec0a24d2",
                "md5": "b6d26f5bb10a9dd42180a736ea69d987",
                "sha256": "2df69523500265d3beeb719a443e8f3955878246e34e634baea368d1582dba5e"
            },
            "downloads": -1,
            "filename": "pysecs-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b6d26f5bb10a9dd42180a736ea69d987",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 25961,
            "upload_time": "2024-12-18T04:23:34",
            "upload_time_iso_8601": "2024-12-18T04:23:34.542442Z",
            "url": "https://files.pythonhosted.org/packages/88/17/c2dddf05abf6d4d1c0180a6333f6ee9ca4667607cd5a9569959bec0a24d2/pysecs-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-18 04:23:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "greglucas",
    "github_project": "pysecs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pysecs"
}

None