added some documentation and jupyter notebook

.gitignore

@@ -14,3 +14,4 @@ build
 dist
 
 _build
+sample.*

docs/api.rst

@@ -1,5 +1,5 @@
-.. figure:: ../telewavesim/examples/picture/tws_logo.png
+.. figure:: ../pyraysum/examples/picture/PYRaysum_logo.png
    :align: center
 
-.. automodule:: telewavesim
+.. automodule:: pyraysum
    :members:

docs/index.rst

@@ -1,14 +1,11 @@
 
-.. figure:: ../telewavesim/examples/picture/tws_logo.png
+.. figure:: ../pyraysum/examples/picture/PyRaysum_logo.png
    :align: center
 
 Documentation
 =============
 
-The structure of the Earth's crust and upper mantle gives useful information on the internal composition and dynamics of our planet. Some of the most widely used techniques to infer these properties are based on examining the effect of teleseismic body wave (i.e., P and S waves that originate from distant earthquakes and arrive as plane waves) propagation (e.g., transmission and scattering) through stratified media. Modeling the
-seismic response from stacks of subsurface layers is therefore an essential tool in characterizing their effect on observed seismograms.
-
-This package contains ``python`` and ``fortran`` modules to synthesize teleseismic body-wave propagation through stacks of generally anisotropic and strictly horizontal layers using the matrix propagator approach of `Kennett (1983) <https://www.oapen.org/search?identifier=459524>`_, as implemented in `Thomson (1997) <https://doi.org/10.1016/S0031-9201(97)00033-2>`_. The software also properly models reverberations from an overlying column of water using the R/T matrix expressions of `Bostock and Trehu (2012) <https://doi.org/10.1785/0120110162>`_, effectively simulating ocean-bottom seismic (OBS) station recordings. The software will be useful in a variety of teleseismic receiver-based studies, such as P or S receiver functions, long-period P-wave polarization, shear-wave splitting from core-refracted shear waves (i.e., SKS, SKKS), etc. It may also be the starting point for stochastic inverse methods (e.g., Monte Carlo sampling). The main part of the code is written in ``fortran`` with ``python`` wrappers. Common computational workflows are covered in the ``Jupyter`` notebooks bundled with this package.
+``PyRaysum`` is a Python wrapper around the Fortran code Raysum, developed by Andrew Frederiksen in collaboration with Michael Bostock. Raysum is a software to model teleseismic body-wave scattering in the presence of layer dip and/or anisotropy. ``PyRaysum`` includes the original Fortran software and provides a script to compile and install Raysum, and functions to interact with the software. Common computational workflows are covered in the ``Jupyter`` notebooks bundled with this package.
 
 .. toctree::
    :maxdepth: 1
@@ -26,15 +23,11 @@ This package contains ``python`` and ``fortran`` modules to synthesize teleseism
    :maxdepth: 1
    :caption: Module
 
-   elast
-   utils
-   wiggles
+   prs
 
 .. toctree::
    :maxdepth: 1
    :caption: Jupyter Notebooks
 
    Example 1: A simple example for OBS <https://nbviewer.jupyter.org/github/paudetseis/Telewavesim/blob/master/telewavesim/examples/Notebooks/sim_obs_Audet2016.ipynb>
-   Example 2: Lower crustal anisotropy <https://nbviewer.jupyter.org/github/paudetseis/Telewavesim/blob/master/telewavesim/examples/Notebooks/sim_Prfs_Porter2011.ipynb>
-   Example 3: Simulating SKS splitting <https://nbviewer.jupyter.org/github/paudetseis/Telewavesim/blob/master/telewavesim/examples/Notebooks/sim_SKS.ipynb>
 

docs/links.rst

@@ -0,0 +1,10 @@
+GitHub Repository
+-----------------
+
+* `PyRaysum <https://github.com/paudetseis/PyRaysum>`_
+
+
+References
+----------
+
+* Frederiksen, A., and Bostock, M.G. (2000). Modelling teleseismic waves in dipping anisotropic structures, 141, 401-412. https://doi.org/10.1046/j.1365-246x.2000.00090.x

docs/prs.rst

@@ -0,0 +1,8 @@
+.. figure:: ../pyraysum/examples/picture/PyRaysum_logo.png
+   :align: center
+
+Module prs
+----------
+
+.. automodule:: pyraysum.prs
+   :members: