mth5 jupyter notebook examples are added

spedas · Feb 17, 2024 · 8419fac · 8419fac
1 parent bb9e36e
commit 8419fac
Show file tree

Hide file tree

Showing 6 changed files with 1,444 additions and 0 deletions.
diff --git a/pyspedas_examples/notebooks/mth5/THEMIS-ARTEMIS-Post-AGU2023_load_fdsn_example.ipynb b/pyspedas_examples/notebooks/mth5/THEMIS-ARTEMIS-Post-AGU2023_load_fdsn_example.ipynb
diff --git a/pyspedas_examples/notebooks/mth5/comparison_with_published_results.ipynb b/pyspedas_examples/notebooks/mth5/comparison_with_published_results.ipynb
diff --git a/pyspedas_examples/notebooks/mth5/explore_station_availability.ipynb b/pyspedas_examples/notebooks/mth5/explore_station_availability.ipynb
diff --git a/pyspedas_examples/notebooks/mth5/load_fdsn_example.ipynb b/pyspedas_examples/notebooks/mth5/load_fdsn_example.ipynb
diff --git a/pyspedas_examples/notebooks/mth5/miniGEM2023_load_fdsn_example.ipynb b/pyspedas_examples/notebooks/mth5/miniGEM2023_load_fdsn_example.ipynb
diff --git a/pyspedas_examples/notebooks/mth5/readme.md b/pyspedas_examples/notebooks/mth5/readme.md
@@ -0,0 +1,26 @@
+# PySPEDAS MTH5 examples
+
+This folder contains Jupyter notebooks illustrating how to work with PySPEDAS mth5 tool.
+mth5 tools allow user to load ground-based magnetic field measurements from International Federation of Digital Seismographic Networks.
+
+| Notebook                                            | Description                                                               |
+|-----------------------------------------------------|---------------------------------------------------------------------------|
+| load_fdsn_example.ipynb                             | Basic example of loading and plotting data from FDSN network              |
+| explore_station_availability.ipynb                  | Instruction of how to explore availability of the stations                |
+| comparison_with_published_results.ipynb             | Step-by-step guide of mth5 tool use and comparison with published results |
+| miniGEM2023_load_fdsn_example.ipynb                 | Notebook presented at min-GEM 2023                                        |
+| THEMIS-ARTEMIS-Post-AGU2023_load_fdsn_example.ipynb | Notebook presented at THEMIS/ARTEMIS Post AGU 2023                        |
+
+# Installation note
+
+PySPEDAS mth5 tool is under active development. If you would like to execute the examples you need to install appropriate `pyspedas` (mth5 branch), `mt_metadata` (main branch), and `mth5` (master branch) packages.
+```
+pip install git+https://github.com/spedas/pyspedas.git@mth5
+pip install git+https://github.com/kujaku11/mt_metadata.git
+pip install git+https://github.com/kujaku11/mth5.git
+```
+
+In addition, you need to have `jupyter` packed installed:
+```
+pip install jupyter
+```