https://github.com/pysat/pysatspaceweather

pysat support for space weather indices and data sets
https://github.com/pysat/pysatspaceweather

forecasting heliophysics ionosphere magnetosphere pysat python space-weather

Last synced: 3 months ago
JSON representation

pysat support for space weather indices and data sets

• Host: GitHub
• URL: https://github.com/pysat/pysatspaceweather
• Owner: pysat
• License: bsd-3-clause
• Created: 2020-08-13T20:52:29.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-13T19:10:40.000Z (4 months ago)
• Last Synced: 2025-01-13T20:22:25.495Z (4 months ago)
• Topics: forecasting, heliophysics, ionosphere, magnetosphere, pysat, python, space-weather
• Language: Python
• Homepage:
• Size: 6.39 MB
• Stars: 10
• Watchers: 4
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Support: docs/supported_instruments.rst

Awesome Lists containing this project

README

        


        

        



# pysatSpaceWeather: pysat support for Space Weather Indices

[![Pytest with Flake8](https://github.com/pysat/pysatSpaceWeather/actions/workflows/main.yml/badge.svg)](https://github.com/pysat/pysatSpaceWeather/actions/workflows/main.yml)

[![Coverage Status](https://coveralls.io/repos/github/pysat/pysatSpaceWeather/badge.svg?branch=main)](https://coveralls.io/github/pysat/pysatSpaceWeather?branch=main)

[![DOI](https://zenodo.org/badge/287377838.svg)](https://zenodo.org/badge/latestdoi/287377838) [![Documentation](https://readthedocs.org/projects/pysatspaceweather/badge/?version=latest)](https://pysatspaceweather.readthedocs.io/en/latest/?badge=latest)

[![PyPI version](https://badge.fury.io/py/pysatSpaceWeather.svg)](https://badge.fury.io/py/pysatSpaceWeather)

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')

```