From c85a400aa7e42b4a0edcf4349eff26d9d1d5e03b Mon Sep 17 00:00:00 2001 From: Jan Gieseler <39489154+jgieseler@users.noreply.github.com> Date: Fri, 14 Jul 2023 12:59:04 +0300 Subject: [PATCH] Update README.rst Remove links to old loader repositoires, add link to example notebook (#38) --- README.rst | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 7733840..ecc7fd5 100644 --- a/README.rst +++ b/README.rst @@ -13,19 +13,16 @@ seppy **A compendium of Python data loaders and analysis tools for in-situ measurements of Solar Energetic Particles (SEP)** -So far combines the following loaders into one PyPI package: +So far combines loaders for the following instruments into one PyPI package: -- `psp-isois-loader `_ -- `soho-loader `_ -- `solo-epd-loader `_ * -- `stereo-loader `_ -- `wind-3dp-loader `_ +- Parker Solar Probe: ISOIS +- SOHO: CELIAS, COSTEP-EPHIN, ERNE +- Solar Orbiter: EPD (STEP, EPT, HET)*, MAG +- STEREO: HET, LET, SEPT, MAG +- Wind: 3DP (* Note that `solo-epd-loader `_ is a `PyPI package itself `_ that just is loaded here for completeness.) -Additional loaders: - -- `solo-mag-loader `_ Disclaimer ---------- @@ -56,14 +53,9 @@ The standard usecase is to utilize the ``***_load`` function, which returns Pand startdate="2021/04/16", enddate="2021/04/20") -Note that the syntax is different for each loader! Please refer to the independent packages for more details and the correct useage: +Note that the syntax is different for each loader! `Please refer to this Notebook for more info and examples for the different data sets! `_ + -- `psp-isois-loader `_ -- `soho-loader `_ -- `solo-epd-loader `_ -- `solo-mag-loader `_ -- `stereo-loader `_ -- `wind-3dp-loader `_ Citation