| Name | pysatSpaceWeather JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | https://github.com/pysat/pysatSpaceWeather |
| Summary | pysat support for Space Weather Indices |
| upload_time | 2024-02-16 22:20:40 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | BSD 3-Clause License Copyright (c) 2020, pysat All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
pysat
ionosphere
heliophysics
magnetosphere
space-weather
forecasting
indexes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="left">
<img height="0" width="0px">
<img width="20%" src="https://raw.githubusercontent.com/pysat/pysatSpaceWeather/main/docs/figures/pysatSpaceWeather.png" alt="pysatSpaceWeather" title="pysatSpaceWeather" </img>
</div>
# pysatSpaceWeather: pysat support for Space Weather Indices
[](https://github.com/pysat/pysatSpaceWeather/actions/workflows/main.yml)
[](https://coveralls.io/github/pysat/pysatSpaceWeather?branch=main)
[](https://zenodo.org/badge/latestdoi/287377838) [](https://pysatspaceweather.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/pysatSpaceWeather)
This module handles solar and geomagnetic indices needed for scientific and
operational projects.
# Installation
The following instructions provide a guide for installing pysatSpaceWeather and
give some examples on how to use the routines.
## Prerequisites
pysatSpaceWeather uses common Python modules, as well as modules developed by
and for the Space Physics community. This module officially supports
Python 3.7+.
| Common modules | Community modules |
| -------------- | ----------------- |
| netCDF4 | pysat >= 3.1.0 |
| numpy | |
| pandas | |
| requests | |
| xarray | |
## PyPi Installation
```
pip install pysatSpaceWeather
```
## GitHub Installation
```
git clone https://github.com/pysat/pysatSpaceWeather.git
```
Change directories into the repository folder and run the setup.py file. For
a local install use the "--user" flag after "install".
```
cd pysatSpaceWeather/
python -m build .
pip install .
```
# Examples
The instrument modules are portable and designed to be run like any pysat
instrument.
```
import pysat
import pysatSpaceWeather
dst = pysat.Instrument(inst_module=pysatSpaceWeather.instruments.sw_dst)
```
Another way to use the instruments in an external repository is to register the
instruments. This only needs to be done the first time you load an instrument.
Afterward, pysat will identify them using the `platform` and `name` keywords.
```
pysat.utils.registry.register('pysatSpaceWeather.instruments.sw_dst')
dst = pysat.Instrument('sw', 'dst')
```
Raw data
{
"_id": null,
"home_page": "https://github.com/pysat/pysatSpaceWeather",
"name": "pysatSpaceWeather",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "pysat,ionosphere,heliophysics,magnetosphere,space-weather,forecasting,indexes",
"author": "",
"author_email": "Angeline Burrell <pysat.developers@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/56/8a/8dafb67cc286a5f4dae222aa51fc388274ea40261024c50f2a9424a3f3fe/pysatSpaceWeather-0.1.0.tar.gz",
"platform": null,
"description": "<div align=\"left\">\n <img height=\"0\" width=\"0px\">\n <img width=\"20%\" src=\"https://raw.githubusercontent.com/pysat/pysatSpaceWeather/main/docs/figures/pysatSpaceWeather.png\" alt=\"pysatSpaceWeather\" title=\"pysatSpaceWeather\" </img>\n</div>\n\n# pysatSpaceWeather: pysat support for Space Weather Indices\n[](https://github.com/pysat/pysatSpaceWeather/actions/workflows/main.yml)\n[](https://coveralls.io/github/pysat/pysatSpaceWeather?branch=main)\n[](https://zenodo.org/badge/latestdoi/287377838) [](https://pysatspaceweather.readthedocs.io/en/latest/?badge=latest)\n[](https://badge.fury.io/py/pysatSpaceWeather)\n\n\nThis module handles solar and geomagnetic indices needed for scientific and\noperational projects.\n\n# Installation\n\nThe following instructions provide a guide for installing pysatSpaceWeather and\ngive some examples on how to use the routines.\n\n## Prerequisites\n\npysatSpaceWeather uses common Python modules, as well as modules developed by\nand for the Space Physics community. This module officially supports\nPython 3.7+.\n\n| Common modules | Community modules |\n| -------------- | ----------------- |\n| netCDF4 | pysat >= 3.1.0 |\n| numpy | |\n| pandas | |\n| requests | |\n| xarray | |\n\n\n## PyPi Installation\n```\npip install pysatSpaceWeather\n```\n\n## GitHub Installation\n```\ngit clone https://github.com/pysat/pysatSpaceWeather.git\n```\n\nChange directories into the repository folder and run the setup.py file. For\na local install use the \"--user\" flag after \"install\".\n\n```\ncd pysatSpaceWeather/\npython -m build .\npip install .\n```\n\n# Examples\n\nThe instrument modules are portable and designed to be run like any pysat\ninstrument.\n\n```\nimport pysat\nimport pysatSpaceWeather\ndst = pysat.Instrument(inst_module=pysatSpaceWeather.instruments.sw_dst)\n```\n\nAnother way to use the instruments in an external repository is to register the\ninstruments. This only needs to be done the first time you load an instrument.\nAfterward, pysat will identify them using the `platform` and `name` keywords.\n\n```\npysat.utils.registry.register('pysatSpaceWeather.instruments.sw_dst')\ndst = pysat.Instrument('sw', 'dst')\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2020, pysat All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "pysat support for Space Weather Indices",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://pysatspaceweather.readthedocs.io/en/latest/",
"Homepage": "https://github.com/pysat/pysatSpaceWeather",
"Source": "https://github.com/pysat/pysatSpaceWeather"
},
"split_keywords": [
"pysat",
"ionosphere",
"heliophysics",
"magnetosphere",
"space-weather",
"forecasting",
"indexes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "34e2bda1b736992b8be83a5855c4674553053b481987e4781daf4c1d97e16018",
"md5": "c5e9409687cec5e657d3d2aaeb40abd5",
"sha256": "fa65007bdab4d06fbe6123d0f1653e69dddde3733c296cd2bf2de24232ec16e0"
},
"downloads": -1,
"filename": "pysatSpaceWeather-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5e9409687cec5e657d3d2aaeb40abd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 103720,
"upload_time": "2024-02-16T22:20:38",
"upload_time_iso_8601": "2024-02-16T22:20:38.386616Z",
"url": "https://files.pythonhosted.org/packages/34/e2/bda1b736992b8be83a5855c4674553053b481987e4781daf4c1d97e16018/pysatSpaceWeather-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "568a8dafb67cc286a5f4dae222aa51fc388274ea40261024c50f2a9424a3f3fe",
"md5": "de48378b5b9ec49191d56a9259dd3a80",
"sha256": "5e1f69bd8c998254c9f5c18d7ba67f6fa79956b705056ae2f5a3e8db8b81b83c"
},
"downloads": -1,
"filename": "pysatSpaceWeather-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "de48378b5b9ec49191d56a9259dd3a80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 67744,
"upload_time": "2024-02-16T22:20:40",
"upload_time_iso_8601": "2024-02-16T22:20:40.289637Z",
"url": "https://files.pythonhosted.org/packages/56/8a/8dafb67cc286a5f4dae222aa51fc388274ea40261024c50f2a9424a3f3fe/pysatSpaceWeather-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 22:20:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pysat",
"github_project": "pysatSpaceWeather",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"test_requirements": [],
"lcname": "pysatspaceweather"
}
