Skip to main content
pysatMadrigal

pysatMadrigal: pysat support for Madrigal data sets

Documentation Status Pytest with Flake8 Coverage Status DOI PyPI version

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.

Metadata

Release files for pysatMadrigal 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pysatMadrigal 0.2.0
File Size Uploaded
pysatMadrigal-0.2.0.tar.gz 57.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pysatMadrigal 0.2.0
File Interpreter ABI Platform
pysatMadrigal-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 122.7 kB

Release files / pysatMadrigal-0.2.0.tar.gz

Download URL pysatMadrigal-0.2.0.tar.gz
Size 57.6 kB
Tags Source
SHA-256 checksum
How to use checksums
422827cebe8c8dd08f436de0ee5d54b0e9226e1928ebc482b725a367ecdc658f
BLAKE2b-256 checksum
How to use checksums
fe94fac991defd62cf55297c45a24ee48db184c335a736fe3fd2257c6c4f5894
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.8

Release files / pysatMadrigal-0.2.0-py3-none-any.whl

Download URL pysatMadrigal-0.2.0-py3-none-any.whl
Size 65.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b9383d255dee1668785efadd003402b1c1237f4dc2f8e715814227fb485e5417
BLAKE2b-256 checksum
How to use checksums
561039cbae282ae605da73e5f5996ac0cf2e632bc66a260fc240a6a43aa41bc4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.8

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.0

2 release files

0.0.4

1 release file

0.0.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page