pysatspaceweather

pysat support for space weather indices and data sets

https://github.com/pysat/pysatspaceweather

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 6 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

forecasting heliophysics ionosphere magnetosphere pysat python space-weather
Last synced: 6 months ago · JSON representation

Repository

pysat support for space weather indices and data sets

Basic Info
  • Host: GitHub
  • Owner: pysat
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 6.39 MB
Statistics
  • Stars: 12
  • Watchers: 3
  • Forks: 5
  • Open Issues: 6
  • Releases: 13
Topics
forecasting heliophysics ionosphere magnetosphere pysat python space-weather
Created over 5 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Support Zenodo

README.md

pysatSpaceWeather

pysatSpaceWeather: pysat support for Space Weather Indices

Pytest with Flake8 Coverage Status DOI Documentation PyPI version

This module handles solar and geomagnetic indices needed for scientific and operational projects.

Installation

The following instructions provide a guide for installing pysatSpaceWeather and give some examples on how to use the routines.

Prerequisites

pysatSpaceWeather 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 | | -------------- | ----------------- | | netCDF4 | pysat >= 3.2.0 | | numpy | | | pandas | | | requests | | | xarray | |

PyPi Installation

pip install pysatSpaceWeather

GitHub Installation

git clone https://github.com/pysat/pysatSpaceWeather.git

Change directories into the repository folder and run the setup.py file. For a local install use the "--user" flag after "install".

cd pysatSpaceWeather/ python -m build . pip install .

Examples

The instrument modules are portable and designed to be run like any pysat instrument.

import pysat import pysatSpaceWeather dst = pysat.Instrument(inst_module=pysatSpaceWeather.instruments.sw_dst)

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('pysatSpaceWeather.instruments.sw_dst') dst = pysat.Instrument('sw', 'dst')

Owner

  • Name: pysat
  • Login: pysat
  • Kind: organization
  • Email: pysatDevelopers@gmail.com

GitHub Events

Total
  • Create event: 4
  • Release event: 1
  • Issues event: 1
  • Watch event: 3
  • Delete event: 4
  • Issue comment event: 2
  • Push event: 7
  • Pull request review comment event: 3
  • Gollum event: 1
  • Pull request event: 5
  • Pull request review event: 8
Last Year
  • Create event: 4
  • Release event: 1
  • Issues event: 1
  • Watch event: 3
  • Delete event: 4
  • Issue comment event: 2
  • Push event: 7
  • Pull request review comment event: 3
  • Gollum event: 1
  • Pull request event: 5
  • Pull request review event: 8

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,004
  • Total Committers: 6
  • Avg Commits per committer: 167.333
  • Development Distribution Score (DDS): 0.325
Past Year
  • Commits: 78
  • Committers: 1
  • Avg Commits per committer: 78.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Angeline Burrell a****l@n****l 678
Jeff Klenzing j****g@g****m 230
Russell Stoneback r****a@u****u 87
Jonathon Smith 3****h 4
asherp a****e@g****m 4
Carey Spence j****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 47
  • Total pull requests: 93
  • Average time to close issues: 6 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 5
  • Total pull request authors: 4
  • Average comments per issue: 1.0
  • Average comments per pull request: 1.3
  • Merged pull requests: 90
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: 11 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.71
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • aburrell (35)
  • rstoneback (6)
  • jklenzing (4)
  • hococoder (1)
  • sespinoza08 (1)
Pull Request Authors
  • aburrell (88)
  • rstoneback (10)
  • jklenzing (7)
  • JonathonMSmith (1)
Top Labels
Issue Labels
enhancement (18) bug (16) maintenance (8) documentation (2) question (1)
Pull Request Labels
bug (11) enhancement (9) maintenance (5) documentation (4)

Dependencies

docs/requirements.txt pypi
  • m2r2 *
  • numpydoc *
  • pysat *
requirements.txt pypi
  • netCDF4 *
  • numpy *
  • packaging *
  • pandas *
  • pysat >=3.0.1
  • requests *
  • xarray *
test_requirements.txt pypi
  • coveralls * test
  • flake8 * test
  • flake8-docstrings * test
  • hacking >=1.0 test
  • m2r2 * test
  • numpydoc * test
  • pytest-cov * test
  • pytest-ordering * test
  • sphinx * test
  • sphinx_rtd_theme * test
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/pysat_rc.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/pip_rc_install.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
setup.py pypi