docs: enable binder (#97)

* add environment configuration file * create notebooks folder and add welcome notebook * add binder link in README file to link welcome notebook * remove demos folder * update docs to add example notebook binder links * update binder links from fork repo to pymt repo * fix typo in example.rst file
csdms · Oct 16, 2019 · ba6862b · ba6862b
1 parent 37b75a4
commit ba6862b
Show file tree

Hide file tree

Showing 17 changed files with 98 additions and 22 deletions.
diff --git a/README.rst b/README.rst
@@ -37,7 +37,8 @@
      <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
    <a href="https://www.codacy.com/app/mcflugen/pymt?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=csdms/pymt&amp;utm_campaign=Badge_Grade">
      <img src="https://api.codacy.com/project/badge/Grade/e8e273131ecb4d7d981fe9f4cf3e83d9"/></a>
-
+   <a href="https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2FWelcome.ipynb">
+     <img alt="Launch Binder" src="https://static.mybinder.org/badge_logo.svg"></a>
    </p>
 
 PyMT is an Open Source Python package, developed by the

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -18,35 +18,50 @@ have to install Jupyter Notebook:
 
 Single Models
 -------------
+* Frost Number Model |binder-frost_number|
+.. |binder-frost_number| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2Ffrost_number.ipynb
 
-* :doc:`Frost Number Model <demos/frost_number>` |macOS| |Linux| |Windows|
-* :doc:`Kudryavtsev Model <demos/ku>` |macOS| |Linux| |Windows|
-* :doc:`GIPL Model<demos/Example_01_Basic_Use_GIPL>` |macOS| |Linux|
-* :doc:`ECSimpleSnow Model <demos/ECSnow_PyMT>` |macOS| |Linux| |Windows|
-* :doc:`Coastline Evolution Model <demos/cem>` |macOS| |Linux|
-* :doc:`Hydrotrend<demos/hydrotrend>` |macOS| |Linux|
-* :doc:`Sedflux3D <demos/sedflux3d>` |macOS| |Linux|
-* :doc:`Flexural Subsidence <demos/subside>` |macOS| |Linux|
+* Kudryavtsev Model |binder-ku|
+.. |binder-ku| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2Fku.ipynb
 
+* GIPL Model |binder-GIPL|
+.. |binder-GIPL| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2FExample_01_Basic_Use_GIPL.ipynb
 
-Coupled Models
---------------
+* ECSimpleSnow Model |binder-ECSnow|
+.. |binder-ECSnow| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2FECSnow_PyMT.ipynb
+
+* Coastline Evolution Model |binder-cem|
+.. |binder-cem| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2Fcem.ipynb
+
+* Hydrotrend |binder-hydrotrend|
+.. |binder-hydrotrend| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2Fhydrotrend.ipynb
 
-* :doc:`Coastline Evolution Model + Waves <demos/cem_and_waves>` |macOS| |Linux|
-* :doc:`GIPL + ECSimpleSnow Models <demos/Example_02_GIPL_ECSimpleSnow>` |macOS| |Linux|
+* Sedflux3D |binder-sedflux3d|
+.. |binder-sedflux3d| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2Fsedflux3d.ipynb
 
+* Flexural Subsidence |binder-subside|
+.. |binder-subside| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2Fsubside.ipynb
+
+
+Coupled Models
+--------------
 
-.. |macOS| image:: _static/apple.svg
-   :height: 15px
-   :alt: macOS
+* Coastline Evolution Model + Waves |binder-cem_and_waves|
+.. |binder-cem_and_waves| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2Fcem_and_waves.ipynb
 
-.. |Linux| image:: _static/linux.svg
-   :height: 15px
-   :alt: Linux
+* GIPL + ECSimpleSnow Models |binder-GIPL_and_ECSnow|
+.. |binder-GIPL_and_ECSnow| image:: https://mybinder.org/badge_logo.svg
+ :target: https://mybinder.org/v2/gh/csdms/pymt.git/master?filepath=notebooks%2FExample_02_GIPL_ECSimpleSnow.ipynb
 
-.. |Windows| image:: _static/windows.svg
-   :height: 15px
-   :alt: Windows
 
 ..
    Sphinx emits a warning if documents aren't in a toctree.

diff --git a/environment.yml b/environment.yml
@@ -0,0 +1,13 @@
+name: test-environment
+channels:
+  - conda-forge
+dependencies:
+  - python=3.7
+  - pymt=1.0.3
+  - pymt_gipl
+  - pymt_ecsimplesnow
+  - seaborn
+  - matplotlib
+  - pandas
+  - numpy
+
diff --git a/docs/demos/ECSnow_PyMT.ipynb → notebooks/ECSnow_PyMT.ipynb b/docs/demos/ECSnow_PyMT.ipynb → notebooks/ECSnow_PyMT.ipynb
diff --git a/docs/demos/Example_01_Basic_Use_GIPL.ipynb → notebooks/Example_01_Basic_Use_GIPL.ipynb b/docs/demos/Example_01_Basic_Use_GIPL.ipynb → notebooks/Example_01_Basic_Use_GIPL.ipynb
diff --git a/.../demos/Example_02_GIPL_ECSimpleSnow.ipynb → notebooks/Example_02_GIPL_ECSimpleSnow.ipynb b/.../demos/Example_02_GIPL_ECSimpleSnow.ipynb → notebooks/Example_02_GIPL_ECSimpleSnow.ipynb
diff --git a/notebooks/Welcome.ipynb b/notebooks/Welcome.ipynb
@@ -0,0 +1,47 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Welcome to Pymt demo Notebooks\n",
+    "\n",
+    "This page provides links to notebooks that provide an introduction to Pymt and its use for different models. \n",
+    "\n",
+    "  * [Coastline Evolution Model](cem.ipynb)\n",
+    "  * [Coastline Evolution Model + Waves](cem_and_waves.ipynb)\n",
+    "  * [ECSimpleSnow component](ECSnow_PyMT.ipynb)\n",
+    "  * [Geophysical Institute Permafrost Laboratory (GIPL) Model](Example_01_Basic_Use_GIPL.ipynb)\n",
+    "  * [GIPL + ECSimpleSnow](Example_02_GIPL_ECSimpleSnow.ipynb)\n",
+    "  * [Frost Number Model](frost_number.ipynb)\n",
+    "  * [HydroTrend Model](hydrotrend.ipynb)\n",
+    "  * [Kudryavtsev Model](ku.ipynb)\n",
+    "  * [Sedflux3D Model](sedflux3d.ipynb)\n",
+    "  * [Flexural Subsidence Model](subside.ipynb)\n",
+    "\n",
+    "  \n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/docs/demos/cem.ipynb → notebooks/cem.ipynb b/docs/demos/cem.ipynb → notebooks/cem.ipynb
diff --git a/docs/demos/cem_and_waves.ipynb → notebooks/cem_and_waves.ipynb b/docs/demos/cem_and_waves.ipynb → notebooks/cem_and_waves.ipynb
diff --git a/docs/demos/child.ipynb → notebooks/child.ipynb b/docs/demos/child.ipynb → notebooks/child.ipynb
diff --git a/docs/demos/frost_number.ipynb → notebooks/frost_number.ipynb b/docs/demos/frost_number.ipynb → notebooks/frost_number.ipynb
diff --git a/docs/demos/hydrotrend.ipynb → notebooks/hydrotrend.ipynb b/docs/demos/hydrotrend.ipynb → notebooks/hydrotrend.ipynb
diff --git a/docs/demos/ku.ipynb → notebooks/ku.ipynb b/docs/demos/ku.ipynb → notebooks/ku.ipynb
diff --git a/docs/demos/quickstart.py → notebooks/quickstart.py b/docs/demos/quickstart.py → notebooks/quickstart.py
diff --git a/docs/demos/sedflux3d.ipynb → notebooks/sedflux3d.ipynb b/docs/demos/sedflux3d.ipynb → notebooks/sedflux3d.ipynb
diff --git a/docs/demos/sedflux3d_and_child.ipynb → notebooks/sedflux3d_and_child.ipynb b/docs/demos/sedflux3d_and_child.ipynb → notebooks/sedflux3d_and_child.ipynb
diff --git a/docs/demos/subside.ipynb → notebooks/subside.ipynb b/docs/demos/subside.ipynb → notebooks/subside.ipynb