| Name | pysatCDAAC JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | |
| Summary | pysat support for CDAAC Instruments |
| upload_time | 2023-08-11 14:45:43 |
| 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
cosmic
radio occultation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<img height="0" width="0px">
<img width="20%" src="https://raw.githubusercontent.com/pysat/pysatCDAAC/main/docs/figures/logo.png" alt="pysat" title="pysatCDAAC"</img>
</div>
# pysatCDAAC: pysat support for COSMIC Data Analysis and Archive Center instruments
[](https://pypi.python.org/pypi/pysatCDAAC)
[](https://github.com/pysat/pysatCDAAC/actions/workflows/main.yml/badge.svg)
[](https://coveralls.io/github/pysat/pysatCDAAC?branch=main)
[](https://zenodo.org/badge/latestdoi/287322558)
### Prerequisites
pysatCDAAC 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.0.4 |
| numpy | |
| pandas | |
| requests | |
| xarray | |
# Installation
Currently, the main way to get pysatCDAAC is through github.
```
git clone https://github.com/pysat/pysatCDAAC.git
```
Change directories into the repository folder and run the setup.py file. For
a local install use the "--user" flag after "install".
```
cd pysatCDAAC/
pip install .
```
Note: pre-1.0.0 version
-----------------------
pysatCDAAC is currently in an initial development phase and requires pysat 3.0.0+.
# Using with pysat
The instrument modules are portable and designed to be run like any pysat instrument.
```
import pysat
from pysatCDAAC.instruments import cosmic_gps
cosmic = pysat.Instrument(inst_module=cosmic_gps, tag='ionprf')
```
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(‘pysatCDAAC.instruments.cosmic_gps’)
cosmic = pysat.Instrument('cosmic', 'gps', tag='ionprf')
```
Raw data
{
"_id": null,
"home_page": "",
"name": "pysatCDAAC",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "pysat,ionosphere,cosmic,radio occultation",
"author": "",
"author_email": "\"Jeff Klenzing, et al.\" <pysat.developers@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1b/a2/442a30c39c903b8c25fcfcfe4233a637bb0aa83d80086a8fe0ccc8030cd8/pysatCDAAC-0.0.4.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img height=\"0\" width=\"0px\">\n <img width=\"20%\" src=\"https://raw.githubusercontent.com/pysat/pysatCDAAC/main/docs/figures/logo.png\" alt=\"pysat\" title=\"pysatCDAAC\"</img>\n</div>\n\n# pysatCDAAC: pysat support for COSMIC Data Analysis and Archive Center instruments\n[](https://pypi.python.org/pypi/pysatCDAAC)\n[](https://github.com/pysat/pysatCDAAC/actions/workflows/main.yml/badge.svg)\n[](https://coveralls.io/github/pysat/pysatCDAAC?branch=main)\n[](https://zenodo.org/badge/latestdoi/287322558)\n\n### Prerequisites\n\npysatCDAAC 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.0.4 |\n| numpy | |\n| pandas | |\n| requests | |\n| xarray | |\n\n# Installation\n\nCurrently, the main way to get pysatCDAAC is through github.\n\n```\ngit clone https://github.com/pysat/pysatCDAAC.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 pysatCDAAC/\npip install .\n```\n\nNote: pre-1.0.0 version\n-----------------------\npysatCDAAC is currently in an initial development phase and requires pysat 3.0.0+.\n\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 pysatCDAAC.instruments import cosmic_gps\n\ncosmic = pysat.Instrument(inst_module=cosmic_gps, tag='ionprf')\n```\nAnother 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.\n\n```\nimport pysat\n\npysat.utils.registry.register(\u2018pysatCDAAC.instruments.cosmic_gps\u2019)\ncosmic = pysat.Instrument('cosmic', 'gps', tag='ionprf')\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 CDAAC Instruments",
"version": "0.0.4",
"project_urls": {
"Documentation": "https://pysatcdaac.readthedocs.io/en/latest/",
"Source": "https://github.com/pysat/pysatCDAAC"
},
"split_keywords": [
"pysat",
"ionosphere",
"cosmic",
"radio occultation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ba2442a30c39c903b8c25fcfcfe4233a637bb0aa83d80086a8fe0ccc8030cd8",
"md5": "7394b02ae4f58dbc69876df338afc635",
"sha256": "a636a8b82a8ff8c91e37eabb4efabbfbdcc24c6996e58463f2a465214a4ebad4"
},
"downloads": -1,
"filename": "pysatCDAAC-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "7394b02ae4f58dbc69876df338afc635",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 22353,
"upload_time": "2023-08-11T14:45:43",
"upload_time_iso_8601": "2023-08-11T14:45:43.485641Z",
"url": "https://files.pythonhosted.org/packages/1b/a2/442a30c39c903b8c25fcfcfe4233a637bb0aa83d80086a8fe0ccc8030cd8/pysatCDAAC-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-11 14:45:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pysat",
"github_project": "pysatCDAAC",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"test_requirements": [],
"lcname": "pysatcdaac"
}
