diff --git a/README.md b/README.md index 17fd990..188bdb6 100644 --- a/README.md +++ b/README.md @@ -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) @@ -33,40 +33,43 @@ Full documentation can be viewed [here](https://el-paso.readthedocs.io/en/latest ## Available processing scripts +Color code: publication ready, needs verification, draft + - **Arase** - - MEPe - - XEP (archived and real-time) - - PWE density + - MEPe + - XEP (archived and real-time) + - PWE density - **DMSP** - - SSJ (electrons) + - SSJ (electrons) - **GOES (13 and 15)** - - EPS MAGED and EPEAD combined + - EPS MAGED and EPEAD combined - **GOES-R** - - MPS-High real-time - - MPS-High + - MPS-High (archived and real-time) - **GPS** - - GPS processing + - GPS processing - **ESA** - - NGRM satellites - - GSSC EMU (electrons and protons) -- **POES** - - MEPED (electrons) - - TED (electrons) + - NGRM satellites + - GSSC EMU (electrons and protons) +- **POES (no proton correction)** + - MEPED (electrons) + - TED (electrons) - **PROBA-V** - - EPT (electrons and protons) + - EPT (electrons and protons) - **THEMIS** - - FFT waves - - Spacecraft-potential density + - FFT waves + - Spacecraft-potential density - **Van Allen Probes** - - HOPE (electrons and protons) - - MagEIS (electrons and protons) - - RBSPICE (protons) - - ECT-combined - - EMFISIS waves - - EMFISIS and EFW density + - HOPE (electrons) + - HOPE (protons) + - MagEIS (electrons) + - MagEIS (protons) + - RBSPICE (protons) + - ECT-combined + - EMFISIS waves + - EMFISIS and EFW density - **Models** - - Last closed drift shell (LCDS) (no spacecraft data needed) - - Solar wind and geomagnetic indices + - Last closed drift shell (LCDS) + - Solar wind and geomagnetic indices Every recipe shares one command line interface; see [Running a recipe](#running-a-recipe) below.