pysatmadrigal
Madrigal instrument support for the pysat ecosystem
Science Score: 46.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
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 7 committers (14.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Madrigal instrument support for the pysat ecosystem
Basic Info
Statistics
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 7
- Releases: 6
Topics
Metadata Files
README.md
pysatMadrigal: pysat support for Madrigal data sets
pysatMadrigal allows users to import data from the Madrigal database into pysat (pysat documentation).
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.
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
- Watch event: 1
- Issue comment event: 1
- Push event: 3
- Pull request review event: 1
- Pull request event: 2
- Create event: 1
Last Year
- Watch event: 1
- Issue comment event: 1
- Push event: 3
- Pull request review event: 1
- Pull request event: 2
- Create event: 1
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Angeline Burrell | a****l@n****l | 286 |
| Jeff Klenzing | j****g@g****m | 155 |
| Russell Stoneback | r****a@u****u | 66 |
| Angeline Burrell | a****l | 34 |
| asherp | a****e@g****m | 3 |
| Russell Stoneback | g****b@s****m | 1 |
| JonathonMSmith | 3****h | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 31
- Total pull requests: 76
- Average time to close issues: 9 months
- Average time to close pull requests: 19 days
- Total issue authors: 3
- Total pull request authors: 4
- Average comments per issue: 1.97
- Average comments per pull request: 2.03
- Merged pull requests: 72
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 26 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 1.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- aburrell (17)
- jklenzing (9)
- rstoneback (5)
Pull Request Authors
- aburrell (53)
- jklenzing (15)
- rstoneback (9)
- JonathonMSmith (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 28 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 4
- Total maintainers: 3
pypi.org: pysatmadrigal
Madrigal instrument support for the pysat ecosystem
- Documentation: https://pysatmadrigal.readthedocs.io/en/latest/
- 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.
-
Latest release: 0.2.0
published almost 2 years ago
Rankings
Dependencies
- h5py *
- m2r2 *
- madrigalWeb *
- numpydoc *
- pandas *
- pysat *
- xarray *
- h5py *
- madrigalWeb *
- numpy *
- pandas *
- pysat >=3.0
- xarray *
- coveralls * test
- flake8 * test
- m2r2 * test
- numpydoc * 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 v3 composite
- actions/setup-python v4 composite