pysat
Generalized data analysis workflow via a consistent easy to use interface.
Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: frontiersin.org, zenodo.org -
✓Committers with academic emails
10 of 24 committers (41.7%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (19.7%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Generalized data analysis workflow via a consistent easy to use interface.
Basic Info
- Host: GitHub
- Owner: pysat
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Homepage: https://join.slack.com/t/pysat/shared_invite/zt-tb9p2fhs-MgFVmA6TwmBhfqpuZeD4rA
- Size: 30 MB
Statistics
- Stars: 160
- Watchers: 8
- Forks: 37
- Open Issues: 57
- Releases: 40
Topics
Metadata Files
README.md
pysat: Python Satellite Data Analysis Toolkit
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.
Full Documentation
JGR-Space Physics Publication
Pysat Ecosystem Publication
Come join us on Slack! An invitation to the pysat workspace is available in the 'About' section of the pysat GitHub Repository. 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.9+.
| 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 topdir/platform/name/tag/instid/files
Detailed examples and tutorials for using pysat are available in the documentation.
Owner
- Name: pysat
- Login: pysat
- Kind: organization
- Email: pysatDevelopers@gmail.com
- Website: https://join.slack.com/t/pysat/shared_invite/zt-tb9p2fhs-MgFVmA6TwmBhfqpuZeD4rA
- Twitter: pysatDevelopers
- Repositories: 15
- Profile: https://github.com/pysat
GitHub Events
Total
- Create event: 5
- Release event: 1
- Issues event: 2
- Watch event: 7
- Delete event: 4
- Issue comment event: 13
- Push event: 11
- Pull request review comment event: 5
- Gollum event: 1
- Pull request review event: 11
- Pull request event: 11
- Fork event: 1
Last Year
- Create event: 5
- Release event: 1
- Issues event: 2
- Watch event: 7
- Delete event: 4
- Issue comment event: 13
- Push event: 11
- Pull request review comment event: 5
- Gollum event: 1
- Pull request review event: 11
- Pull request event: 11
- Fork event: 1
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Russell Stoneback | r****a@u****u | 3,044 |
| Jeff Klenzing | j****g@g****m | 2,657 |
| Angeline Burrell | a****l@n****l | 1,408 |
| asherp | a****e@g****m | 82 |
| Carey Spence | j****e | 56 |
| Veronica Von Bose | v****0@c****u | 44 |
| aburrell | a****3@l****k | 41 |
| JonathonMSmith | 3****h | 34 |
| Matthew Depew | m****w@u****u | 25 |
| Nathaniel Hargrave | n****0@c****u | 21 |
| Aadarsh Govada | a****a@n****v | 14 |
| Smith | j****7@g****v | 8 |
| rfuller81 | 7****1 | 7 |
| Jeff Klenzing | j****g@J****e | 7 |
| aburrell | a****0@u****u | 5 |
| Tracy Esman | 2****n | 4 |
| matthew | m****w@m****l | 4 |
| vvonbose | v****3@s****t | 3 |
| Embrace | s****e@g****m | 2 |
| Gayatri | 3****2 | 2 |
| Jin Lee | j****0@u****u | 1 |
| armando | a****o@u****u | 1 |
| gayatri | g****i@m****l | 1 |
| mdepew | m****w@1****4 | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 110
- Total pull requests: 113
- Average time to close issues: about 1 year
- Average time to close pull requests: 16 days
- Total issue authors: 6
- Total pull request authors: 9
- Average comments per issue: 2.14
- Average comments per pull request: 1.73
- Merged pull requests: 100
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 3
- Pull requests: 16
- Average time to close issues: 7 months
- Average time to close pull requests: about 1 month
- Issue authors: 1
- Pull request authors: 3
- Average comments per issue: 1.0
- Average comments per pull request: 0.94
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jklenzing (43)
- rstoneback (33)
- aburrell (28)
- t-esman (2)
- landsito (1)
- Aadarsh-Govada (1)
- Imtiaz08 (1)
Pull Request Authors
- jklenzing (83)
- aburrell (28)
- rstoneback (12)
- namurphy (2)
- JonathonMSmith (2)
- dependabot[bot] (2)
- Aadarsh-Govada (2)
- Gayatri012 (1)
- t-esman (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 3,854 last-month
- Total dependent packages: 5
- Total dependent repositories: 23
- Total versions: 50
- Total maintainers: 3
pypi.org: pysat
Supports science analysis across disparate data platforms
- Documentation: https://pysat.readthedocs.io/en/latest/
- 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.
-
Latest release: 3.2.2
published 11 months ago
Rankings
Dependencies
- docutils <0.18
- ipython *
- m2r2 *
- netCDF4 *
- numpydoc *
- packaging *
- pandas *
- portalocker *
- pytest *
- readthedocs-sphinx-search ==0.1.1
- sphinx ==4.2.0
- sphinx_rtd_theme ==1.0.0
- xarray *
- dask *
- netCDF4 *
- numpy >=1.12
- pandas *
- portalocker *
- pytest *
- scipy *
- toolz *
- xarray *
- coveralls <3.3 test
- flake8 * test
- flake8-docstrings * test
- hacking >=1.0 test
- ipython * test
- m2r2 * test
- numpydoc * test
- pysatSpaceWeather * test
- pytest-cov * test
- pytest-ordering * test
- sphinx * test
- sphinx_rtd_theme * test
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite