add a page about the apps

geoscixyz · Jan 27, 2017 · a814255 · a814255
1 parent b203413
commit a814255
Show file tree

Hide file tree

Showing 8 changed files with 85 additions and 32 deletions.
diff --git a/apps.rst b/apps.rst
@@ -2,13 +2,94 @@ Apps
 ====
 
 To augment the content in EM GeoSci, a number of `Jupyter
-Notebook <http://jupyter.org>`_ apps have been developed. There are two categories of notebooks
+Notebook <http://jupyter.org>`_ apps have been developed.
+There are two categories of notebooks
 
-- Apps
+- :ref:`EM Apps <em_apps>`
     - **Purpose:** To provide an interactive way to explore fundamentals of EM geophysics
 
-- Simulation Notebooks
+- :ref:`Simulation Notebooks <simulation_notebooks>`
     - **Purpose:** To be a starting point for getting up and running with the EM Module of SimPEG for performing numerical simulations and inversions
 
+.. We have provided instructions on working with the apps in the `Jupyter
+.. Notebook<http://jupyter.org>`_ environment.
 
+.. _em_apps:
 
+EM Apps
+-------
+
+There are three ways you can run the notebooks
+
+- Microsoft Azure (free, login required, stable):
+- Binders (free, no login required, not-so-stable): http://mybinder.org/repo/geoscixyz/em_apps
+- Download from Github (free, installation of python required): http://github.com/geoscixyz/em_apps
+
+.. image:: images/DC_LayeredEarth_notebook.png
+
+Within the Jupyter Notebook environment, you can use :code:`shift + enter` to run
+each cell of code, or from the menu, select :code:`cell, run all`
+
+.. image:: images/run_all_cells.png
+
+
+Notebooks include
+^^^^^^^^^^^^^^^^^
+
+**Physical Properties**
+
+- Cole-Cole response: Complex conductivity
+
+**Maxwell 1: Fundamentals**
+
+- FDEM Planewave in Wholespace
+- FDEM Electric Dipole in Wholespace
+- FDEM Electric Dipole in Wholespace
+- TDEM Electric Dipole in Wholespace
+- TDEM Electric Dipole in Wholespace
+- Induction RL circuit (two loops)
+
+**Maxwell 2: DC**
+
+- Electrostatic Sphere
+- DC Layered Earth
+- DC 2D Cylinder in Halfspace
+- DC 2.5D Cylinder in Halfspace
+- DC 2D Plate in Halfspace
+- DC 2.5D Plate in Halfspace
+- DC 2D shielding effects in Halfspace
+- DC 2.5D shielding effects in Halfspace
+- DC Building Pseudosections
+
+
+**Maxwell 3: FDEM**
+
+- FDEM Vertical Magnetic Dipole in Layered-earth
+
+**Maxwell 4: TDEM**
+
+- TDEM Horizontal Circular loop in Layered-earth
+
+**Geophysical Surveys**
+
+- MT Layered earth
+
+
+
+.. _simulation_notebooks:
+
+Simulation Notebooks
+--------------------
+
+These notebooks walk through forward simulations of both frequency domain
+electromagnetics and time domain electromagnetics using `SimPEG <http://simpeg.xyz>`_.
+
+These notebooks are available
+
+- Microsoft Azure (free, login required, stable):
+- Binders (free, no login required, not-so-stable): http://mybinder.org/repo/simpeg/em_notebooks
+- Download from Github (free, installation of python required): http://github.com/simpeg/em_notebooks
+
+Further examples and documentation are available at http://simpeg.xyz.
+
+.. image:: ./images/FDEM_sounding_over_sphere.png
diff --git a/auto_examples/auto_examples_jupyter.zip b/auto_examples/auto_examples_jupyter.zip
diff --git a/auto_examples/auto_examples_python.zip b/auto_examples/auto_examples_python.zip
diff --git a/auto_examples/index.rst b/auto_examples/index.rst
diff --git a/conf.py b/conf.py
@@ -46,7 +46,7 @@
     'purpose',
     'question',
     # 'sphinx_nbexamples'
-    'sphinx_gallery.gen_gallery',
+    # 'sphinx_gallery.gen_gallery',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/images/DC_LayeredEarth_notebook.png b/images/DC_LayeredEarth_notebook.png
diff --git a/images/FDEM_sounding_over_sphere.png b/images/FDEM_sounding_over_sphere.png
diff --git a/images/run_all_cells.png b/images/run_all_cells.png