| Name | pysat JSON |
| Version |
3.2.0
JSON |
| download |
| home_page | None |
| Summary | Supports science analysis across disparate data platforms |
| upload_time | 2024-03-27 22:16:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | Copyright (c) 2016, Russell Stoneback All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * Neither the name of pysat 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
atmosphere
thermosphere
magnetosphere
heliosphere
observations
models
space
satellites
analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
dask
netCDF4
numpy
pandas
portalocker
pytest
scipy
toolz
xarray
|
| 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/pysat/main/docs/images/logo.png" alt="The pysat logo: A snake orbiting a blue sphere" title="pysat"</img>
</div>
# pysat: Python Satellite Data Analysis Toolkit
[](https://pypi.python.org/pypi/pysat)
[](https://github.com/pysat/pysat/actions/workflows/main.yml/badge.svg)
[](http://pysat.readthedocs.io/en/latest/?badge=latest)
[](https://coveralls.io/github/pysat/pysat?branch=main)
[](https://zenodo.org/badge/latestdoi/33449914)
The Python Satellite Data Analysis Toolkit (pysat) provides a simple and
flexible interface for robust data analysis from beginning to end - including
downloading, loading, cleaning, managing, processing, and analyzing data.
Pysat's plug-in design allows analysis support for any data, including user
provided data sets. The pysat team provides a variety of plug-ins to support
public scientific data sets in packages such as pysatNASA, pysatMadrigal, and
more, available as part of the general [pysat ecosystem](https://github.com/pysat).
Full [Documentation](http://pysat.readthedocs.io/en/latest/index.html)
JGR-Space Physics [Publication](https://doi.org/10.1029/2018JA025297)
Pysat Ecosystem [Publication](https://www.frontiersin.org/articles/10.3389/fspas.2023.1119775/full)
[Citation Info](https://pysat.readthedocs.io/en/latest/citing.html)
Come join us on Slack! An invitation to the pysat workspace is available
in the 'About' section of the
[pysat GitHub Repository.](https://github.com/pysat/pysat)
Development meetings are generally held fortnightly.
# Main Features
* Instrument independent analysis routines.
* Instrument object providing an interface for downloading and analyzing a wide
variety of science data sets.
* Uses pandas or xarray for the underlying data structure;
capable of handling the many forms scientific measurements take in a
consistent manner.
* Standard scientific data handling tasks (e.g., identifying, downloading,
and loading files and cleaning and modifying data) are built into the
Instrument object.
* Supports metadata consistent with the netCDF CF-1.6 standard. Each variable
has a name, long name, and units. Note units are informational only.
* Simplifies data management
* Iterator support for loading data by day/file/orbit, independent of data
storage details.
* Orbits are calculated on the fly from loaded data and span day breaks.
* Iterate over custom seasons
* Supports rigorous time-series calculations that require spin up/down time
across day, orbit, and file breaks.
* Includes helper functions to reduce the barrier in adding new science
instruments to pysat
# Installation
The following instructions provide a guide for installing pysat and give some
examples on how to use the routines.
## Prerequisites
pysat uses common Python modules, as well as modules developed by and for the
Space Physics community. This module officially supports Python 3.X+.
| Common modules | Community modules |
| -------------- | ----------------- |
| dask | netCDF4 |
| numpy >= 1.12 | |
| pandas | |
| portalocker | |
| pytest | |
| scipy | |
| toolz | |
| xarray | |
## PyPi Installation
```
pip install pysat
```
## GitHub Installation
```
git clone https://github.com/pysat/pysat.git
```
Change directories into the repository folder and run the pyproject.toml or
setup.py file. For a local install use the "--user" flag after "install".
```
cd pysat/
python -m build .
pip install .
```
# Using pysat
* The first time pysat is run, you will need to specify a directory to store
the data. In Python, run:
```
pysat.params['data_dirs'] = 'path/to/directory/that/may/or/may/not/exist'
```
* Nominal organization of data is top_dir/platform/name/tag/inst_id/files
Detailed examples and tutorials for using pysat are available in the
[documentation](http://pysat.readthedocs.io/en/latest/index.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "pysat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "pysat, ionosphere, atmosphere, thermosphere, magnetosphere, heliosphere, observations, models, space, satellites, analysis",
"author": null,
"author_email": "\"Russell Stoneback, et al.\" <pysat.developers@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/92/af/549bf4b5043465cf28408a3d141a7bbfa0ff08ac739e1ca30debed8ef7e6/pysat-3.2.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img height=\"0\" width=\"0px\">\n <img width=\"20%\" src=\"https://raw.githubusercontent.com/pysat/pysat/main/docs/images/logo.png\" alt=\"The pysat logo: A snake orbiting a blue sphere\" title=\"pysat\"</img>\n</div>\n\n# pysat: Python Satellite Data Analysis Toolkit\n[](https://pypi.python.org/pypi/pysat)\n[](https://github.com/pysat/pysat/actions/workflows/main.yml/badge.svg)\n[](http://pysat.readthedocs.io/en/latest/?badge=latest)\n[](https://coveralls.io/github/pysat/pysat?branch=main)\n[](https://zenodo.org/badge/latestdoi/33449914)\n\nThe Python Satellite Data Analysis Toolkit (pysat) provides a simple and\nflexible interface for robust data analysis from beginning to end - including\ndownloading, loading, cleaning, managing, processing, and analyzing data.\nPysat's plug-in design allows analysis support for any data, including user\nprovided data sets. The pysat team provides a variety of plug-ins to support\npublic scientific data sets in packages such as pysatNASA, pysatMadrigal, and\nmore, available as part of the general [pysat ecosystem](https://github.com/pysat).\n\nFull [Documentation](http://pysat.readthedocs.io/en/latest/index.html)\n\nJGR-Space Physics [Publication](https://doi.org/10.1029/2018JA025297)\n\nPysat Ecosystem [Publication](https://www.frontiersin.org/articles/10.3389/fspas.2023.1119775/full)\n\n[Citation Info](https://pysat.readthedocs.io/en/latest/citing.html)\n\nCome join us on Slack! An invitation to the pysat workspace is available\nin the 'About' section of the\n[pysat GitHub Repository.](https://github.com/pysat/pysat)\nDevelopment meetings are generally held fortnightly.\n\n# Main Features\n* Instrument independent analysis routines.\n* Instrument object providing an interface for downloading and analyzing a wide\n variety of science data sets.\n * Uses pandas or xarray for the underlying data structure;\n capable of handling the many forms scientific measurements take in a\n consistent manner.\n * Standard scientific data handling tasks (e.g., identifying, downloading,\n and loading files and cleaning and modifying data) are built into the\n Instrument object.\n * Supports metadata consistent with the netCDF CF-1.6 standard. Each variable\n has a name, long name, and units. Note units are informational only.\n* Simplifies data management\n * Iterator support for loading data by day/file/orbit, independent of data\n storage details.\n * Orbits are calculated on the fly from loaded data and span day breaks.\n * Iterate over custom seasons\n* Supports rigorous time-series calculations that require spin up/down time\n across day, orbit, and file breaks.\n* Includes helper functions to reduce the barrier in adding new science\n instruments to pysat\n\n# Installation\n\nThe following instructions provide a guide for installing pysat and give some\nexamples on how to use the routines.\n\n## Prerequisites\n\npysat uses common Python modules, as well as modules developed by and for the\nSpace Physics community. This module officially supports Python 3.X+.\n\n| Common modules | Community modules |\n| -------------- | ----------------- |\n| dask | netCDF4 |\n| numpy >= 1.12 | |\n| pandas | |\n| portalocker | |\n| pytest | |\n| scipy | |\n| toolz | |\n| xarray | |\n\n\n## PyPi Installation\n```\npip install pysat\n```\n\n## GitHub Installation\n```\ngit clone https://github.com/pysat/pysat.git\n```\n\nChange directories into the repository folder and run the pyproject.toml or\nsetup.py file. For a local install use the \"--user\" flag after \"install\".\n\n```\ncd pysat/\npython -m build .\npip install .\n```\n\n# Using pysat\n\n* The first time pysat is run, you will need to specify a directory to store\n the data. In Python, run:\n```\npysat.params['data_dirs'] = 'path/to/directory/that/may/or/may/not/exist'\n```\n * Nominal organization of data is top_dir/platform/name/tag/inst_id/files\n\nDetailed examples and tutorials for using pysat are available in the\n[documentation](http://pysat.readthedocs.io/en/latest/index.html).\n",
"bugtrack_url": null,
"license": "Copyright (c) 2016, Russell Stoneback All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * Neither the name of pysat 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": "Supports science analysis across disparate data platforms",
"version": "3.2.0",
"project_urls": {
"Documentation": "https://pysat.readthedocs.io/en/latest/",
"Source": "https://github.com/pysat/pysat"
},
"split_keywords": [
"pysat",
" ionosphere",
" atmosphere",
" thermosphere",
" magnetosphere",
" heliosphere",
" observations",
" models",
" space",
" satellites",
" analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92af549bf4b5043465cf28408a3d141a7bbfa0ff08ac739e1ca30debed8ef7e6",
"md5": "eed7dd511731335ec2a33ab12547f395",
"sha256": "37f1320af42f07c323b0f25108fe4b51e4badf6d1748a1ed3f1cc03069afdb1e"
},
"downloads": -1,
"filename": "pysat-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "eed7dd511731335ec2a33ab12547f395",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 288136,
"upload_time": "2024-03-27T22:16:03",
"upload_time_iso_8601": "2024-03-27T22:16:03.850482Z",
"url": "https://files.pythonhosted.org/packages/92/af/549bf4b5043465cf28408a3d141a7bbfa0ff08ac739e1ca30debed8ef7e6/pysat-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 22:16:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pysat",
"github_project": "pysat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "dask",
"specs": []
},
{
"name": "netCDF4",
"specs": []
},
{
"name": "numpy",
"specs": [
[
">=",
"1.12"
]
]
},
{
"name": "pandas",
"specs": []
},
{
"name": "portalocker",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "toolz",
"specs": []
},
{
"name": "xarray",
"specs": []
}
],
"test_requirements": [
{
"name": "coveralls",
"specs": [
[
"<",
"3.3"
]
]
},
{
"name": "flake8",
"specs": []
},
{
"name": "flake8-docstrings",
"specs": []
},
{
"name": "hacking",
"specs": [
[
">=",
"1.0"
]
]
},
{
"name": "ipython",
"specs": []
},
{
"name": "m2r2",
"specs": []
},
{
"name": "numpydoc",
"specs": []
},
{
"name": "pysatSpaceWeather",
"specs": [
[
"<",
"0.1.0"
]
]
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "pytest-ordering",
"specs": []
},
{
"name": "readthedocs-sphinx-search",
"specs": [
[
"==",
"0.3.2"
]
]
},
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx_rtd_theme",
"specs": [
[
"<",
"2.0.0"
],
[
">=",
"1.2.2"
]
]
}
],
"lcname": "pysat"
}
