https://github.com/pysat/pysatmadrigal
Madrigal instrument support for the pysat ecosystem
https://github.com/pysat/pysatmadrigal
dmsp jicamarca madrigal pysat radar satellite
Last synced: 8 months ago
JSON representation
Madrigal instrument support for the pysat ecosystem
- Host: GitHub
- URL: https://github.com/pysat/pysatmadrigal
- Owner: pysat
- License: bsd-3-clause
- Created: 2020-04-24T02:32:03.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T16:15:51.000Z (about 2 years ago)
- Last Synced: 2024-06-11T19:51:29.975Z (about 2 years ago)
- Topics: dmsp, jicamarca, madrigal, pysat, radar, satellite
- Language: Python
- Homepage:
- Size: 6.81 MB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 8
-
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
![]()
# pysatMadrigal: pysat support for Madrigal data sets
[](https://pysatmadrigal.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/pysat/pysatMadrigal/actions/workflows/main.yml)
[](https://coveralls.io/github/pysat/pysatMadrigal?branch=main)
[](https://zenodo.org/badge/latestdoi/258384773)
[](https://badge.fury.io/py/pysatMadrigal)
pysatMadrigal allows users to import data from the Madrigal database into
pysat ([pysat documentation](http://pysat.readthedocs.io/en/latest/)).
# 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](https://pysatmadrigal.readthedocs.io/en/latest/?badge=latest).