Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 29 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ SPDX-License-Identifier: Apache-2.0
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Versions | [![PyPi](https://badge.fury.io/py/el-paso.svg)](https://badge.fury.io/py/el-paso) [![Python version](https://img.shields.io/pypi/pyversions/el-paso.svg)](https://badge.fury.io/py/el-paso) [![Zenodo](https://img.shields.io/badge/Zenodo-10.5281/zenodo.20760790-blue)](https://doi.org/10.5281/zenodo.20760790) |
| Status | [![Tests](https://github.com/GFZ/EL_PASO/actions/workflows/test.yml/badge.svg)](https://github.com/GFZ/EL_PASO/actions/workflows/test.yml) [![Coverage Status](https://coveralls.io/repos/github/GFZ/EL_PASO/badge.svg?branch=main)](https://coveralls.io/github/GFZ/EL_PASO?branch=main) [![Docs](https://app.readthedocs.org/projects/el-paso/badge/?version=latest)](https://el-paso.readthedocs.io/en/latest/) [![REUSE status](https://api.reuse.software/badge/github.com/GFZ/EL_PASO)](https://api.reuse.software/info/github.com/GFZ/EL_PASO) |
| Tools | [![Pre-Commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty) |
| Tools | [![Pre-Commit](https://img.shields.io/badge/pre--commit-enabled-bright#4a8a4f?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty) |
| License | [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) |
| Paper | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/GFZ/EL_PASO/executable_paper?urlpath=%2Fdoc%2Ftree%2Fpaper%2Fel_paso_executable_paper.ipynb) [![Paper](https://img.shields.io/badge/Open_Access-10.22541/essoar.15002644/v1-blue)](https://essopenarchive.org/doi/abs/10.22541/essoar.15002644/v1) |
| SPEC | [![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) [![SPEC 1 — Lazy Loading of Submodules and Functions](https://img.shields.io/badge/SPEC-1-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0001/) |
| SPEC | [![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-#4a8a4f?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) [![SPEC 1 — Lazy Loading of Submodules and Functions](https://img.shields.io/badge/SPEC-1-#4a8a4f?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0001/) |

# ELaborative Particle Analysis from Satellite Observations (EL-PASO)

Expand All @@ -33,40 +33,43 @@ Full documentation can be viewed [here](https://el-paso.readthedocs.io/en/latest

## Available processing scripts

Color code: <span style="color:#4a8a4f">publication ready</span>, <span style="color:E6D753">needs verification</span>, <span style="color:E67D53">draft</span>

- **Arase**
- MEPe
- XEP (archived and real-time)
- PWE density
- <span style="color:E6D753"> MEPe
- <span style="color:#4a8a4f"> XEP (archived and real-time)
- <span style="color:#4a8a4f"> PWE density
- **DMSP**
- SSJ (electrons)
- <span style="color:E6D753"> SSJ (electrons)
- **GOES (13 and 15)**
- EPS MAGED and EPEAD combined
- <span style="color:#4a8a4f"> EPS MAGED and EPEAD combined
- **GOES-R**
- MPS-High real-time
- MPS-High
- <span style="color:E6D753"> MPS-High (archived and real-time)
- **GPS**
- GPS processing
- <span style="color:E6D753"> GPS processing
- **ESA**
- NGRM satellites
- GSSC EMU (electrons and protons)
- **POES**
- MEPED (electrons)
- TED (electrons)
- <span style="color:E67D53"> NGRM satellites
- <span style="color:E67D53"> GSSC EMU (electrons and protons)
- **POES (no proton correction)**
- <span style="color:#4a8a4f"> MEPED (electrons)
- <span style="color:#4a8a4f"> TED (electrons)
- **PROBA-V**
- EPT (electrons and protons)
- <span style="color:E6D753"> EPT (electrons and protons)
- **THEMIS**
- FFT waves
- Spacecraft-potential density
- <span style="color:E6D753"> FFT waves
- <span style="color:E6D753"> Spacecraft-potential density
- **Van Allen Probes**
- HOPE (electrons and protons)
- MagEIS (electrons and protons)
- RBSPICE (protons)
- ECT-combined
- EMFISIS waves
- EMFISIS and EFW density
- <span style="color:#4a8a4f"> HOPE (electrons)
- <span style="color:E67D53"> HOPE (protons)
- <span style="color:#4a8a4f"> MagEIS (electrons)
- <span style="color:E67D53"> MagEIS (protons)
- <span style="color:E67D53"> RBSPICE (protons)
- <span style="color:#4a8a4f"> ECT-combined
- <span style="color:#4a8a4f"> EMFISIS waves
- <span style="color:#4a8a4f"> EMFISIS and EFW density
- **Models**
- Last closed drift shell (LCDS) (no spacecraft data needed)
- Solar wind and geomagnetic indices
- <span style="color:#4a8a4f"> Last closed drift shell (LCDS)
- <span style="color:#4a8a4f"> Solar wind and geomagnetic indices

Every recipe shares one command line interface; see
[Running a recipe](#running-a-recipe) below.
Expand Down
Loading