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

Project details


Download files

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

Source Distribution

pysatspaceweather-0.2.1.tar.gz (70.3 kB view details)

Uploaded Source

Built Distribution

pysatSpaceWeather-0.2.1-py3-none-any.whl (108.3 kB view details)

Uploaded Python 3

File details

Details for the file pysatspaceweather-0.2.1.tar.gz.

File metadata

  • Download URL: pysatspaceweather-0.2.1.tar.gz
  • Upload date:
  • Size: 70.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pysatspaceweather-0.2.1.tar.gz
Algorithm Hash digest
SHA256 39d6730b91e6d1a9190ad76aa13a4ee64b918a28e0d1603e02a478dd0cf37849
MD5 e9ef2626c52b8bc0096597cf9b64c9da
BLAKE2b-256 b751e1d1c82b0182fed7aeb6ac629b6d80ed6b0ac1ca125a13d37b9e12ddfbdf

See more details on using hashes here.

File details

Details for the file pysatSpaceWeather-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pysatSpaceWeather-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6c4c0ea2415677db1dc1304b47d5e12c4478f0ff8ec5fde4165bf8f5158d732a
MD5 d040635055e8047e64cae71816786b8d
BLAKE2b-256 f4dd1913978a24181736184767431ef338abebdfe4e1a061cbcc666f4aafba4f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page