| Name | pysatNASA JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | |
| Summary | pysat support for NASA Instruments |
| upload_time | 2023-06-27 22:13:42 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | BSD 3-Clause License Copyright (c) 2023, 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
magnetosphere
solar wind
thermosphere
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
beautifulsoup4
cdasws
cdflib
lxml
netCDF4
numpy
pandas
pysat
requests
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/pysatNASA/main/docs/figures/pysatnasa_logo.png" alt="pysatNASA" title="pysatNASA" </img>
</div>
# pysatNASA: pysat support for NASA Space Science instruments
[](https://pypi.python.org/pypi/pysatNASA)
[](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
[](https://coveralls.io/github/pysat/pysatNASA?branch=main)
[](https://pysatnasa.readthedocs.io/en/latest/?badge=latest)
[](https://zenodo.org/badge/latestdoi/287387638)
# Installation
The following instructions provide a guide for installing pysatNASA and give
some examples on how to use the routines
### Prerequisites
pysatNASA 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 | Optional Modules |
| ---------------- | ----------------- |------------------|
| beautifulsoup4 | cdflib>=0.4.4 | pysatCDF |
| lxml | pysat>=3.1.0 | |
| netCDF4 | | |
| numpy | | |
| pandas | | |
| requests | | |
| xarray | | |
## PyPi Installation
```
pip install pysatNASA
```
## GitHub Installation
```
git clone https://github.com/pysat/pysatNASA.git
```
Change directories into the repository folder and build the project. For
a local install use the "--user" flag after "install".
```
cd pysatNASA/
pip install .
```
Note: pre-1.0.0 version
-----------------------
pysatNASA is currently in an initial development phase and requires pysat 3.1.0.
Feedback and contributions are appreciated.
# Using with pysat
The instrument modules are portable and designed to be run like any pysat instrument.
```
import pysat
from pysatNASA.instruments import icon_ivm
ivm = pysat.Instrument(inst_module=icon_ivm, inst_id='a')
```
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.
```
import pysat
pysat.utils.registry.register(['pysatNASA.instruments.icon_ivm'])
ivm = pysat.Instrument('icon', 'ivm', inst_id='a')
```
# CDF Integration
For data products stored as CDF files, this package can use either `cdflib` or
`pysatCDF`. Note that `cdflib` is a pure python package and more readily
deployable across systems, whereas `pysatCDF` interfaces with the fortran.
This is a faster approach for loading data, but may not install on all systems.
There are known issues with `numpy`>=1.24. Therefore, `pysatCDF` is optional
rather than required.
You can specify which load routine to use via the optional `use_cdflib` kwarg.
If no kwarg is specified, `pysatNASA` will default to `pysatCDF` if it is
successfully installed, and default to `cdflib` otherwise.
```
ivm = pysat.Instrument('cnofs', 'ivm', use_cdflib=True)
```
Raw data
{
"_id": null,
"home_page": "",
"name": "pysatNASA",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "pysat,ionosphere,magnetosphere,solar wind,thermosphere",
"author": "",
"author_email": "\"Jeff Klenzing, et al.\" <pysat.developers@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a6/86/3d80f8f3d21f860b9402b5fb20dc4d08e0b85355118221206da89f70c901/pysatNASA-0.0.5.tar.gz",
"platform": null,
"description": "<div align=\"left\">\n <img height=\"0\" width=\"0px\">\n <img width=\"20%\" src=\"https://raw.githubusercontent.com/pysat/pysatNASA/main/docs/figures/pysatnasa_logo.png\" alt=\"pysatNASA\" title=\"pysatNASA\" </img>\n</div>\n\n# pysatNASA: pysat support for NASA Space Science instruments\n[](https://pypi.python.org/pypi/pysatNASA)\n[](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)\n[](https://coveralls.io/github/pysat/pysatNASA?branch=main)\n\n[](https://pysatnasa.readthedocs.io/en/latest/?badge=latest)\n[](https://zenodo.org/badge/latestdoi/287387638)\n\n# Installation\n\nThe following instructions provide a guide for installing pysatNASA and give\nsome examples on how to use the routines\n\n### Prerequisites\n\npysatNASA uses common Python modules, as well as modules developed by\nand for the Space Physics community. This module officially supports\nPython 3.6+.\n\n| Common modules | Community modules | Optional Modules |\n| ---------------- | ----------------- |------------------|\n| beautifulsoup4 | cdflib>=0.4.4 | pysatCDF |\n| lxml | pysat>=3.1.0 | |\n| netCDF4 | | |\n| numpy | | |\n| pandas | | |\n| requests | | |\n| xarray | | |\n\n## PyPi Installation\n```\npip install pysatNASA\n```\n\n## GitHub Installation\n\n```\ngit clone https://github.com/pysat/pysatNASA.git\n```\n\nChange directories into the repository folder and build the project. For\na local install use the \"--user\" flag after \"install\".\n\n```\ncd pysatNASA/\npip install .\n```\n\nNote: pre-1.0.0 version\n-----------------------\npysatNASA is currently in an initial development phase and requires pysat 3.1.0. \nFeedback and contributions are appreciated.\n\n# Using with pysat\n\nThe instrument modules are portable and designed to be run like any pysat instrument.\n\n```\nimport pysat\nfrom pysatNASA.instruments import icon_ivm\n\nivm = pysat.Instrument(inst_module=icon_ivm, inst_id='a')\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```\nimport pysat\n\npysat.utils.registry.register(['pysatNASA.instruments.icon_ivm'])\nivm = pysat.Instrument('icon', 'ivm', inst_id='a')\n```\n\n# CDF Integration\nFor data products stored as CDF files, this package can use either `cdflib` or\n`pysatCDF`. Note that `cdflib` is a pure python package and more readily\ndeployable across systems, whereas `pysatCDF` interfaces with the fortran. \nThis is a faster approach for loading data, but may not install on all systems. \nThere are known issues with `numpy`>=1.24. Therefore, `pysatCDF` is optional\nrather than required. \n\nYou can specify which load routine to use via the optional `use_cdflib` kwarg.\nIf no kwarg is specified, `pysatNASA` will default to `pysatCDF` if it is\nsuccessfully installed, and default to `cdflib` otherwise.\n\n```\nivm = pysat.Instrument('cnofs', 'ivm', use_cdflib=True)\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, 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 NASA Instruments",
"version": "0.0.5",
"project_urls": {
"Documentation": "https://pysatnasa.readthedocs.io/en/latest/",
"Source": "https://github.com/pysat/pysatNASA"
},
"split_keywords": [
"pysat",
"ionosphere",
"magnetosphere",
"solar wind",
"thermosphere"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6863d80f8f3d21f860b9402b5fb20dc4d08e0b85355118221206da89f70c901",
"md5": "2e12b7b8a7a19ede514532ab9a96f17d",
"sha256": "c9f9b32b7b26f9dbac9316ffcefed31bfb89a08b67b897655785b05808bcf3a9"
},
"downloads": -1,
"filename": "pysatNASA-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "2e12b7b8a7a19ede514532ab9a96f17d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 73660,
"upload_time": "2023-06-27T22:13:42",
"upload_time_iso_8601": "2023-06-27T22:13:42.326514Z",
"url": "https://files.pythonhosted.org/packages/a6/86/3d80f8f3d21f860b9402b5fb20dc4d08e0b85355118221206da89f70c901/pysatNASA-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 22:13:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pysat",
"github_project": "pysatNASA",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "beautifulsoup4",
"specs": []
},
{
"name": "cdasws",
"specs": []
},
{
"name": "cdflib",
"specs": [
[
">=",
"0.4.4"
]
]
},
{
"name": "lxml",
"specs": []
},
{
"name": "netCDF4",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pysat",
"specs": [
[
">=",
"3.1.0"
]
]
},
{
"name": "requests",
"specs": []
},
{
"name": "xarray",
"specs": []
}
],
"test_requirements": [
{
"name": "coveralls",
"specs": [
[
"<",
"3.3"
]
]
},
{
"name": "extras_require",
"specs": []
},
{
"name": "flake8",
"specs": []
},
{
"name": "flake8-docstrings",
"specs": []
},
{
"name": "hacking",
"specs": [
[
">=",
"1.0"
]
]
},
{
"name": "ipython",
"specs": []
},
{
"name": "m2r2",
"specs": []
},
{
"name": "numpydoc",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "pytest-ordering",
"specs": []
},
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx_rtd_theme",
"specs": []
}
],
"lcname": "pysatnasa"
}
