Merge branch 'mn5hk:main' into main

abhimhamane · Jun 5, 2024 · 0a88f1d · 0a88f1d
2 parents fda8579 + 0ec5042
commit 0a88f1d
Show file tree

Hide file tree

Showing 123 changed files with 382 additions and 24,021 deletions.
diff --git a/.github/workflows/ci-docs-gh-pages.yml b/.github/workflows/ci-docs-gh-pages.yml
@@ -3,6 +3,9 @@ on:
   push:
     branches: 
       - main
+      - 106-prereview
+      - 106-prereview-joss
+
 permissions:
   contents: write
 jobs:

diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+notebooks/.ipynb_checkpoints
+notebooks/.ipynb_checkpoints/*
+pyshbundle.egg-info/PKG-INFO
+pyshbundle/.ipynb_checkoutpoints/
+pyshbundle/.ipynb_checkpoints/*
+pyshbundle/__pycache__/
+pyshbundle/__pycache__/*
diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -0,0 +1,10 @@
+# Tutorials
+
+In order to make getting started with PySHBundle simple, we have curated a set of introductory tutorials in form of jupyter notebooks. Data for trying out this new tool is included in the repo. After installing and cloning the repo, go to the notebooks directory in order to find explainatory ipython jupyter notebooks. Simply activate the virtual environment and fire up these jupyter notebooks. The following notebooks explain the usage of the tool aswell as some crucial basics of Spherical Harmonics processing for Grace.
+
+1. [Introduction to Spherical Harmonics](https://github.com/mn5hk/pyshbundle/blob/main/notebooks/01_intro_spherical_harmonics_with_pyshbundle.ipynb)
+2. [Loading the data](https://github.com/mn5hk/pyshbundle/blob/main/notebooks/02_load_data.ipynb)
+3. [Visualizations](https://github.com/mn5hk/pyshbundle/blob/main/notebooks/03_visualizations.ipynb)
+4. [Terrestrial Water Storage (TWS) Time Series](https://github.com/mn5hk/pyshbundle/blob/main/notebooks/04_TWS_time_series.ipynb)
+5. [Tests and Validation notebook](https://github.com/mn5hk/pyshbundle/blob/main/notebooks/tests_validation_pyshbundle.ipynb)
+
diff --git a/docs/usage.md b/docs/usage.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -41,7 +41,7 @@ nav:
     - Home: index.md
     - Theoretical Background: theory.md
     - Installation: installation.md
-    - Usage: usage.md
+    - Tutorials: tutorials.md
     - Contributing: contributing.md
     - FAQ: faq.md
     - Changelog: changelog.md

diff --git a/notebooks/.ipynb_checkpoints/01_intro_spherical_harmonics_with_pyshbundle-checkpoint.ipynb b/notebooks/.ipynb_checkpoints/01_intro_spherical_harmonics_with_pyshbundle-checkpoint.ipynb
diff --git a/notebooks/.ipynb_checkpoints/02_load_data-checkpoint.ipynb b/notebooks/.ipynb_checkpoints/02_load_data-checkpoint.ipynb
diff --git a/notebooks/.ipynb_checkpoints/03_visualizations-checkpoint.ipynb b/notebooks/.ipynb_checkpoints/03_visualizations-checkpoint.ipynb
diff --git a/notebooks/.ipynb_checkpoints/04_TWS_time_series-checkpoint.ipynb b/notebooks/.ipynb_checkpoints/04_TWS_time_series-checkpoint.ipynb
diff --git a/notebooks/.ipynb_checkpoints/04_validation_pyshbundle-checkpoint.ipynb b/notebooks/.ipynb_checkpoints/04_validation_pyshbundle-checkpoint.ipynb
diff --git a/notebooks/.ipynb_checkpoints/06_filtering_with_pyshbundle-checkpoint.ipynb b/notebooks/.ipynb_checkpoints/06_filtering_with_pyshbundle-checkpoint.ipynb
diff --git a/notebooks/.ipynb_checkpoints/intro_gddc-checkpoint.ipynb b/notebooks/.ipynb_checkpoints/intro_gddc-checkpoint.ipynb