Improve published section (#98)

examples/add_ons/README.rst

@@ -1,2 +1,7 @@
 Add-ons
 =======
+
+There are currently two add-ons included in `empymod`: (1) `fdesign` is a tool
+to design digital linear filters for any linear transform, and (2) `tmtemod`
+is an adaption of the regular `dipole` routine that returns the field split
+into TE and TM mode.

examples/comparisons/README.rst

@@ -1,2 +1,6 @@
 Comparisons to analytical solution
 ==================================
+
+Included in `empymod` are analytical fullspace and halfspace solutions in the
+frequency and time domain. Here some comparisons of analytical results with
+numerical results.

examples/coordinate_system.py

@@ -1,6 +1,6 @@
 r"""
-Coordinate system
-=================
+Definition of the coordinate system in empymod
+==============================================
 
 Short version
 -------------

examples/published/README.rst

@@ -1,67 +1,5 @@
 Published results
 =================
 
-A lot of examples can be found in the notebooks which belong to published
-results. Here an overview where you can find those.
-
-Introduction to Controlled-Source Electromagnetic Methods
----------------------------------------------------------
-
-See the notebooks in the repo `empymod/csem-ziolkowski-and-slob
-<https://github.com/empymod/csem-ziolkowski-and-slob>`_ for:
-
-    Ziolkowski, A., and E. Slob, 2019, **Introduction to Controlled-Source
-    Electromagnetic Methods**: Cambridge University Press; ISBN `9781107058620
-    <https://www.cambridge.org/9781107058620>`_.
-
-The notebooks contain all numerical examples of the book, 61 in total,
-frequency- and time-domain.
-
-
-An open-source full 3D electromagnetic modeler for 1D VTI media in Python: empymod
-----------------------------------------------------------------------------------
-
-See the notebooks in the repo `empymod/article-geo2017
-<https://github.com/empymod/article-geo2017>`_ for:
-
-    Werthmüller, D., 2017, **An open-source full 3D electromagnetic modeler for
-    1D VTI media in Python: empymod**: Geophysics, 82(6), WB9-WB19; DOI:
-    `10.1190/geo2016-0626.1 <http://doi.org/10.1190/geo2016-0626.1>`_.
-
-The notebooks contain:
-
-- Comparison to analytical solution
-- DLF filter comparison
-- GPR example
-- Time-domain example
-
-
-A tool for designing digital filters for the Hankel and Fourier transforms in potential, diffusive, and wavefield modeling
---------------------------------------------------------------------------------------------------------------------------
-
-See the notebooks in the repo `empymod/article-fdesign
-<https://github.com/empymod/article-fdesign>`_ for:
-
-    Werthmüller, D., K. Key, and E. Slob, 2019, **A tool for designing digital
-    filters for the Hankel and Fourier transforms in potential, diffusive, and
-    wavefield modeling**:  Geophysics, 84(2), F47-F56; DOI:
-    `10.1190/geo2018-0069.1 <http://doi.org/10.1190/geo2018-0069.1>`_.
-
-The notebooks contain:
-
-- Examples regarding the design of digital filters for the Hankel and Fourier
-  transforms
-- GPR example with a digital filter
-
-
-Getting started with controlled-source electromagnetic 1D modeling
-------------------------------------------------------------------
-
-See the notebooks in the repo `empymod/article-tle2017
-<https://github.com/empymod/article-tle2017>`_ for:
-
-    Werthmüller, D., 2017, **Getting started with controlled-source
-    electromagnetic 1D modeling**: The Leading Edge, 36, 352-355; doi:
-    `10.1190/tle36040352.1 <http://dx.doi.org/10.1190/tle36040352.1>`_.
-
-Contains 2 notebooks with eight frequency- and time-domain examples.
+A lot of examples can be found in the repos and accompanying notebooks which
+belong to published results. Here an overview where you can find those.

examples/published/article_werthmuller-2017-GEO.py

@@ -0,0 +1,21 @@
+"""
+empymod-paper: Werthmüller, 2017, Geophysics
+============================================
+
+See the notebooks in the repo `empymod/article-geo2017
+<https://github.com/empymod/article-geo2017>`_ for:
+
+    Werthmüller, D., 2017, **An open-source full 3D electromagnetic modeler for
+    1D VTI media in Python: empymod**: Geophysics, 82(6), WB9-WB19; DOI:
+    `10.1190/geo2016-0626.1 <http://doi.org/10.1190/geo2016-0626.1>`_.
+
+The notebooks contain:
+
+- Comparison to analytical solution
+- DLF filter comparison
+- GPR example
+- Time-domain example
+
+"""
+pass  # THIS IS NOT AN ACTUAL EXAMPLE, see text above for the actual repo
+# sphinx_gallery_thumbnail_path = '_static/thumbs/werthmuller2017_GEO.jpg'

examples/published/article_werthmuller-2019-GEO.py

@@ -0,0 +1,22 @@
+"""
+fdesign-paper: Werthmüller et al., 2019, Geophysics
+===================================================
+
+See the notebooks in the repo `empymod/article-fdesign
+<https://github.com/empymod/article-fdesign>`_ for:
+
+    Werthmüller, D., K. Key, and E. Slob, 2019, **A tool for designing digital
+    filters for the Hankel and Fourier transforms in potential, diffusive, and
+    wavefield modeling**:  Geophysics, 84(2), F47-F56; DOI:
+    `10.1190/geo2018-0069.1 <http://doi.org/10.1190/geo2018-0069.1>`_.
+
+The notebooks contain:
+
+- Examples regarding the design of digital filters for the Hankel and Fourier
+  transforms
+- GPR example with a digital filter
+
+
+"""
+pass  # THIS IS NOT AN ACTUAL EXAMPLE, see text above for the actual repo
+# sphinx_gallery_thumbnail_path = '_static/thumbs/werthmuller2019_GEO.jpg'

examples/published/book_ziolkowski-slob-2019-CPU.py

@@ -0,0 +1,17 @@
+"""
+CSEM-Book: Ziolkowski & Slob, 2019, CUP
+=======================================
+
+See the notebooks in the repo `empymod/csem-ziolkowski-and-slob
+<https://github.com/empymod/csem-ziolkowski-and-slob>`_ for:
+
+    Ziolkowski, A., and E. Slob, 2019, **Introduction to Controlled-Source
+    Electromagnetic Methods**: Cambridge University Press; ISBN `9781107058620
+    <https://www.cambridge.org/9781107058620>`_.
+
+The notebooks contain all numerical examples of the book, 61 in total,
+frequency- and time-domain.
+
+"""
+pass  # THIS IS NOT AN ACTUAL EXAMPLE, see text above for the actual repo
+# sphinx_gallery_thumbnail_path = '_static/thumbs/ziolkowski2019_CPU.jpg'

examples/published/tutorial_werthmuller-2017-TLE.py

@@ -0,0 +1,16 @@
+"""
+empymod-tutorial: Werthmüller, 2017, The Leading Edge
+=====================================================
+
+See the notebooks in the repo `empymod/article-tle2017
+<https://github.com/empymod/article-tle2017>`_ for:
+
+    Werthmüller, D., 2017, **Getting started with controlled-source
+    electromagnetic 1D modeling**: The Leading Edge, 36, 352-355; doi:
+    `10.1190/tle36040352.1 <http://dx.doi.org/10.1190/tle36040352.1>`_.
+
+Contains 2 notebooks with eight frequency- and time-domain examples.
+
+"""
+pass  # THIS IS NOT AN ACTUAL EXAMPLE, see text above for the actual repo
+# sphinx_gallery_thumbnail_path = '_static/thumbs/werthmuller2017_TLE.jpg'

examples/reproducing/README.rst

@@ -1,2 +1,5 @@
 Reproducing published results
 =============================
+
+This section contains examples that use `empymod` to reproduce published
+results that were computed using other codes.