| Name | pysatMadrigal JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | Madrigal instrument support for the pysat ecosystem |
| upload_time | 2024-03-15 21:08:21 |
| 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
madrigal
cedar
thermosphere
gps
gnss
tec
jicamarca
dmsp
isr
incoherent scatter radar
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
h5py
madrigalWeb
numpy
packaging
pandas
pysat
xarray
|
| 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/pysatMadrigal/main/docs/figures/pysatMadrigal.png" alt="pysatMadrigal" title="pysatMadrigal"</img>
</div>
# pysatMadrigal: pysat support for Madrigal data sets
[](https://pysatmadrigal.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/pysat/pysatMadrigal/actions/workflows/main.yml)
[](https://coveralls.io/github/pysat/pysatMadrigal?branch=main)
[](https://zenodo.org/badge/latestdoi/258384773)
[](https://badge.fury.io/py/pysatMadrigal)
pysatMadrigal allows users to import data from the Madrigal database into
pysat ([pysat documentation](http://pysat.readthedocs.io/en/latest/)).
# Installation
The following instructions provide a guide for installing pysatMadrigal and
give some examples on how to use the routines.
## Prerequisites
pysatMadrigal uses common Python modules, as well as modules developed by and
for the Space Physics community. This module officially supports Python 3.6+.
| Common modules | Community modules |
| -------------- | ----------------- |
| h5py | madrigalWeb>=2.6 |
| numpy | pysat >= 3.1.0 |
| pandas | |
| xarray | |
## PyPi Installation
```
pip install pysatMadrigal
```
## GitHub Installation
```
git clone https://github.com/pysat/pysatMadrigal.git
```
Change directories into the repository folder and run the setup.py file. For
a local install use the "--user" flag after "install".
```
cd pysatMadrigal/
python -m build .
pip install .
```
# Examples
The instrument modules are portable and designed to be run like any pysat
instrument.
```
import pysat
from pysatMadrigal.instruments import dmsp_ivm
ivm = pysat.Instrument(inst_module=dmsp_ivm, tag='utd', inst_id='f15')
```
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('pysatMadrigal.instruments.dmsp_ivm')
ivm = pysat.Instrument('dmsp', 'ivm', tag='utd', inst_id='f15')
```
The package also include analysis tools. Detailed examples are in the
[documentation](https://pysatmadrigal.readthedocs.io/en/latest/?badge=latest).
Raw data
{
"_id": null,
"home_page": "",
"name": "pysatMadrigal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "pysat,ionosphere,Madrigal,CEDAR,thermosphere,GPS,GNSS,TEC,Jicamarca,DMSP,ISR,Incoherent scatter radar",
"author": "",
"author_email": "\"Angeline G. Burrell et al.\" <pysat.developers@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fe/94/fac991defd62cf55297c45a24ee48db184c335a736fe3fd2257c6c4f5894/pysatMadrigal-0.2.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/pysatMadrigal/main/docs/figures/pysatMadrigal.png\" alt=\"pysatMadrigal\" title=\"pysatMadrigal\"</img>\n</div>\n\n# pysatMadrigal: pysat support for Madrigal data sets\n[](https://pysatmadrigal.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/pysat/pysatMadrigal/actions/workflows/main.yml)\n[](https://coveralls.io/github/pysat/pysatMadrigal?branch=main)\n[](https://zenodo.org/badge/latestdoi/258384773)\n[](https://badge.fury.io/py/pysatMadrigal)\n\npysatMadrigal allows users to import data from the Madrigal database into\npysat ([pysat documentation](http://pysat.readthedocs.io/en/latest/)).\n\n\n# Installation\n\nThe following instructions provide a guide for installing pysatMadrigal and\ngive some examples on how to use the routines.\n\n## Prerequisites\n\npysatMadrigal uses common Python modules, as well as modules developed by and\nfor the Space Physics community. This module officially supports Python 3.6+.\n\n| Common modules | Community modules |\n| -------------- | ----------------- |\n| h5py | madrigalWeb>=2.6 |\n| numpy | pysat >= 3.1.0 |\n| pandas | |\n| xarray | |\n\n\n## PyPi Installation\n```\npip install pysatMadrigal\n```\n\n## GitHub Installation\n```\ngit clone https://github.com/pysat/pysatMadrigal.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 pysatMadrigal/\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\nfrom pysatMadrigal.instruments import dmsp_ivm\nivm = pysat.Instrument(inst_module=dmsp_ivm, tag='utd', inst_id='f15')\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('pysatMadrigal.instruments.dmsp_ivm')\nivm = pysat.Instrument('dmsp', 'ivm', tag='utd', inst_id='f15')\n```\n\nThe package also include analysis tools. Detailed examples are in the\n[documentation](https://pysatmadrigal.readthedocs.io/en/latest/?badge=latest).\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": "Madrigal instrument support for the pysat ecosystem",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://pysatmadrigal.readthedocs.io/en/latest/",
"Source": "https://github.com/pysat/pysatMadrigal"
},
"split_keywords": [
"pysat",
"ionosphere",
"madrigal",
"cedar",
"thermosphere",
"gps",
"gnss",
"tec",
"jicamarca",
"dmsp",
"isr",
"incoherent scatter radar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "561039cbae282ae605da73e5f5996ac0cf2e632bc66a260fc240a6a43aa41bc4",
"md5": "c47f6dcec86c83825bd85e780edce074",
"sha256": "b9383d255dee1668785efadd003402b1c1237f4dc2f8e715814227fb485e5417"
},
"downloads": -1,
"filename": "pysatMadrigal-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c47f6dcec86c83825bd85e780edce074",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 65159,
"upload_time": "2024-03-15T21:08:19",
"upload_time_iso_8601": "2024-03-15T21:08:19.969240Z",
"url": "https://files.pythonhosted.org/packages/56/10/39cbae282ae605da73e5f5996ac0cf2e632bc66a260fc240a6a43aa41bc4/pysatMadrigal-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe94fac991defd62cf55297c45a24ee48db184c335a736fe3fd2257c6c4f5894",
"md5": "0812426611042f5cb59076330f3a74e5",
"sha256": "422827cebe8c8dd08f436de0ee5d54b0e9226e1928ebc482b725a367ecdc658f"
},
"downloads": -1,
"filename": "pysatMadrigal-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "0812426611042f5cb59076330f3a74e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 57577,
"upload_time": "2024-03-15T21:08:21",
"upload_time_iso_8601": "2024-03-15T21:08:21.966058Z",
"url": "https://files.pythonhosted.org/packages/fe/94/fac991defd62cf55297c45a24ee48db184c335a736fe3fd2257c6c4f5894/pysatMadrigal-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 21:08:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pysat",
"github_project": "pysatMadrigal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "h5py",
"specs": []
},
{
"name": "madrigalWeb",
"specs": [
[
">=",
"2.6"
]
]
},
{
"name": "numpy",
"specs": []
},
{
"name": "packaging",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pysat",
"specs": [
[
">=",
"3.1.0"
]
]
},
{
"name": "xarray",
"specs": []
}
],
"test_requirements": [
{
"name": "coveralls",
"specs": []
},
{
"name": "flake8",
"specs": []
},
{
"name": "flake8-docstrings",
"specs": []
},
{
"name": "hacking",
"specs": [
[
">=",
"1.0"
]
]
},
{
"name": "m2r2",
"specs": []
},
{
"name": "numpydoc",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "pytest-ordering",
"specs": []
},
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx_rtd_theme",
"specs": [
[
"<",
"2.0.0"
],
[
">=",
"1.2.2"
]
]
}
],
"lcname": "pysatmadrigal"
}
