Skip to main content

'pysat support for Space Weather Indices'

Project description

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.7+.

Common modules Community modules
netCDF4 pysat >= 3.0.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 setup.py install

Note: pre-0.1.0 version

pysatSpaceWeather is currently in an alpha development phase. Feedback and contributions are appreciated.

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pysatSpaceWeather, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size pysatSpaceWeather-0.0.4.tar.gz (41.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page