fixed init and added source install instructions

Author: paudetseis

README.md

@@ -33,7 +33,7 @@ Included in this package is a set of Jupyter Notebooks, which give examples on h
 These notebooks can be installed (in a local folder `Notebooks`) from the package by running:
 
 ```python
-import telewavesim.doc as doc
+from telewavesim import doc
 doc.install_doc(path='Notebooks')
 ```
 
@@ -86,10 +86,10 @@ where `telewavesim` can be installed along with its dependencies.
 conda create -n tws python=3.7 obspy pyfftw -c conda-forge
 ```
 
-- or create it from the `tws_env.yml` file by first cloning the repository:
+- or create it from the `tws_env.yml` file by first checking out the repository:
 
 ```bash
-git clone https://github.com/paudetseis/Telewavesim.git
+git checkout https://github.com/paudetseis/Telewavesim.git
 cd Telewavesim
 conda env create -f tws_env.yml
 ```
@@ -106,23 +106,25 @@ Install `telewavesim` with `pip`:
 pip install telewavesim
 ```
 
-## Usage
-
-Telewavesim consists of Python wrappers around Fortran routines that return the Fourier transform of displacement seismograms in three components (see `Jupyter` notebooks for details). The Python modules can be used to define new elastic stiffness matrices or change the input parameters for the Fortran subroutines. Python modules are available for post-processing as well (e.g., calculation of receiver functions).
-
-A series of tests are located in the ``tests`` subdirectory. In order to perform these tests, clone the reposotiry and run `pytest` (`conda install pytest` if needed):
+### Installing from source
 
+First clone the repository:
 ```bash
-git checkout https://github.com/paudetseis/Telewavesim.git
+git clone https://github.com/paudetseis/Telewavesim.git
 cd Telewavesim
-pytest -v
 ```
 
+Next we recommend following the steps for creating a `conda` environment (see above). Then install using `pip`:
+
+```bash
+pip install .
+``` 
+
 ---
 **NOTE**
 
 If you are actively working on the code, or making frequent edits, it is advisable to perform 
-installation from source using ``pip`` with the `-e` flag: 
+installation from source with the `-e` flag: 
 
 ```bash
 pip install -e .
@@ -134,6 +136,19 @@ package available on the system.
 
 ---
 
+## Usage
+
+Telewavesim consists of Python wrappers around Fortran routines that return the Fourier transform of displacement seismograms in three components (see `Jupyter` notebooks for details). The Python modules can be used to define new elastic stiffness matrices or change the input parameters for the Fortran subroutines. Python modules are available for post-processing as well (e.g., calculation of receiver functions).
+
+A series of tests are located in the ``tests`` subdirectory. In order to perform these tests, clone the reposotiry and run `pytest` (`conda install pytest` if needed):
+
+```bash
+git checkout https://github.com/paudetseis/Telewavesim.git
+cd Telewavesim
+pytest -v
+```
+
+
 ## References
 1. Audet, P. (2016). Receiver functions using OBS data: promises and limitations from numerical modelling and examples from the Cascadia Initiative. Geophysical Journal International, 205, 1740-1755. https://doi.org/10.1093/gji/ggw111
 2. Kennett, B.L.N. (1983). Seismic wave propagation in stratified media. Cambridge University Press, 342pp.

examples/.ipynb_checkpoints/0-Start-Here-checkpoint.ipynb

@@ -39,7 +39,7 @@
     "These notebooks can be installed (in a local folder `Notebooks`) from the package by running:\n",
     "\n",
     "```python\n",
-    "import telewavesim.doc as doc\n",
+    "from telewavesim import doc\n",
     "doc.install_doc(path='Notebooks')\n",
     "```\n",
     "\n",
@@ -92,10 +92,10 @@
     "conda create -n tws python=3.7 obspy pyfftw -c conda-forge\n",
     "```\n",
     "\n",
-    "- or create it from the `tws_env.yml` file by first cloning the repository:\n",
+    "- or create it from the `tws_env.yml` file by first checking out the repository:\n",
     "\n",
     "```bash\n",
-    "git clone https://github.com/paudetseis/Telewavesim.git\n",
+    "git checkout https://github.com/paudetseis/Telewavesim.git\n",
     "cd Telewavesim\n",
     "conda env create -f tws_env.yml\n",
     "```\n",
@@ -112,23 +112,25 @@
     "pip install telewavesim\n",
     "```\n",
     "\n",
-    "## Usage\n",
-    "\n",
-    "Telewavesim consists of Python wrappers around Fortran routines that return the Fourier transform of displacement seismograms in three components (see `Jupyter` notebooks for details). The Python modules can be used to define new elastic stiffness matrices or change the input parameters for the Fortran subroutines. Python modules are available for post-processing as well (e.g., calculation of receiver functions).\n",
-    "\n",
-    "A series of tests are located in the ``tests`` subdirectory. In order to perform these tests, clone the reposotiry and run `pytest` (`conda install pytest` if needed):\n",
+    "### Installing from source\n",
     "\n",
+    "First clone the repository:\n",
     "```bash\n",
-    "git checkout https://github.com/paudetseis/Telewavesim.git\n",
+    "git clone https://github.com/paudetseis/Telewavesim.git\n",
     "cd Telewavesim\n",
-    "pytest -v\n",
     "```\n",
     "\n",
+    "Next we recommend following the steps for creating a `conda` environment (see above). Then install using `pip`:\n",
+    "\n",
+    "```bash\n",
+    "pip install .\n",
+    "``` \n",
+    "\n",
     "---\n",
     "**NOTE**\n",
     "\n",
     "If you are actively working on the code, or making frequent edits, it is advisable to perform \n",
-    "installation from source using ``pip`` with the `-e` flag: \n",
+    "installation from source with the `-e` flag: \n",
     "\n",
     "```bash\n",
     "pip install -e .\n",
@@ -140,6 +142,19 @@
     "\n",
     "---\n",
     "\n",
+    "## Usage\n",
+    "\n",
+    "Telewavesim consists of Python wrappers around Fortran routines that return the Fourier transform of displacement seismograms in three components (see `Jupyter` notebooks for details). The Python modules can be used to define new elastic stiffness matrices or change the input parameters for the Fortran subroutines. Python modules are available for post-processing as well (e.g., calculation of receiver functions).\n",
+    "\n",
+    "A series of tests are located in the ``tests`` subdirectory. In order to perform these tests, clone the reposotiry and run `pytest` (`conda install pytest` if needed):\n",
+    "\n",
+    "```bash\n",
+    "git checkout https://github.com/paudetseis/Telewavesim.git\n",
+    "cd Telewavesim\n",
+    "pytest -v\n",
+    "```\n",
+    "\n",
+    "\n",
     "## References\n",
     "1. Audet, P. (2016). Receiver functions using OBS data: promises and limitations from numerical modelling and examples from the Cascadia Initiative. Geophysical Journal International, 205, 1740-1755. https://doi.org/10.1093/gji/ggw111\n",
     "2. Kennett, B.L.N. (1983). Seismic wave propagation in stratified media. Cambridge University Press, 342pp.\n",

examples/0-Start-Here.ipynb

@@ -39,7 +39,7 @@
     "These notebooks can be installed (in a local folder `Notebooks`) from the package by running:\n",
     "\n",
     "```python\n",
-    "import telewavesim.doc as doc\n",
+    "from telewavesim import doc\n",
     "doc.install_doc(path='Notebooks')\n",
     "```\n",
     "\n",
@@ -92,10 +92,10 @@
     "conda create -n tws python=3.7 obspy pyfftw -c conda-forge\n",
     "```\n",
     "\n",
-    "- or create it from the `tws_env.yml` file by first cloning the repository:\n",
+    "- or create it from the `tws_env.yml` file by first checking out the repository:\n",
     "\n",
     "```bash\n",
-    "git clone https://github.com/paudetseis/Telewavesim.git\n",
+    "git checkout https://github.com/paudetseis/Telewavesim.git\n",
     "cd Telewavesim\n",
     "conda env create -f tws_env.yml\n",
     "```\n",
@@ -112,23 +112,25 @@
     "pip install telewavesim\n",
     "```\n",
     "\n",
-    "## Usage\n",
-    "\n",
-    "Telewavesim consists of Python wrappers around Fortran routines that return the Fourier transform of displacement seismograms in three components (see `Jupyter` notebooks for details). The Python modules can be used to define new elastic stiffness matrices or change the input parameters for the Fortran subroutines. Python modules are available for post-processing as well (e.g., calculation of receiver functions).\n",
-    "\n",
-    "A series of tests are located in the ``tests`` subdirectory. In order to perform these tests, clone the reposotiry and run `pytest` (`conda install pytest` if needed):\n",
+    "### Installing from source\n",
     "\n",
+    "First clone the repository:\n",
     "```bash\n",
-    "git checkout https://github.com/paudetseis/Telewavesim.git\n",
+    "git clone https://github.com/paudetseis/Telewavesim.git\n",
     "cd Telewavesim\n",
-    "pytest -v\n",
     "```\n",
     "\n",
+    "Next we recommend following the steps for creating a `conda` environment (see above). Then install using `pip`:\n",
+    "\n",
+    "```bash\n",
+    "pip install .\n",
+    "``` \n",
+    "\n",
     "---\n",
     "**NOTE**\n",
     "\n",
     "If you are actively working on the code, or making frequent edits, it is advisable to perform \n",
-    "installation from source using ``pip`` with the `-e` flag: \n",
+    "installation from source with the `-e` flag: \n",
     "\n",
     "```bash\n",
     "pip install -e .\n",
@@ -140,6 +142,19 @@
     "\n",
     "---\n",
     "\n",
+    "## Usage\n",
+    "\n",
+    "Telewavesim consists of Python wrappers around Fortran routines that return the Fourier transform of displacement seismograms in three components (see `Jupyter` notebooks for details). The Python modules can be used to define new elastic stiffness matrices or change the input parameters for the Fortran subroutines. Python modules are available for post-processing as well (e.g., calculation of receiver functions).\n",
+    "\n",
+    "A series of tests are located in the ``tests`` subdirectory. In order to perform these tests, clone the reposotiry and run `pytest` (`conda install pytest` if needed):\n",
+    "\n",
+    "```bash\n",
+    "git checkout https://github.com/paudetseis/Telewavesim.git\n",
+    "cd Telewavesim\n",
+    "pytest -v\n",
+    "```\n",
+    "\n",
+    "\n",
     "## References\n",
     "1. Audet, P. (2016). Receiver functions using OBS data: promises and limitations from numerical modelling and examples from the Cascadia Initiative. Geophysical Journal International, 205, 1740-1755. https://doi.org/10.1093/gji/ggw111\n",
     "2. Kennett, B.L.N. (1983). Seismic wave propagation in stratified media. Cambridge University Press, 342pp.\n",

examples/Notebooks/sim_obs_Audet2016.ipynb

@@ -6,13 +6,13 @@
 
 setup(
     name = 'telewavesim',
-    version = '0.0.6',
+    version = '0.0.7',
     description = 'Python package for teleseismic body-wave modeling',
     author = 'Pascal Audet, Colin J. Thomson, Michael G. Bostock',
     maintainer = 'Pascal Audet',
     author_email = '[email protected]',
     url = 'https://github.com/paudetseis/Telewavesim', 
-    download_url = 'https://github.com/paudetseis/Telewavesim/archive/0.0.6.tar.gz',
+    download_url = 'https://github.com/paudetseis/Telewavesim/archive/0.0.7.tar.gz',
     classifiers = [
         'Development Status :: 3 - Alpha',
         'License :: OSI Approved :: MIT License',
@@ -28,7 +28,6 @@
         'telewavesim': [
             'examples/*.ipynb',
             'examples/models/*.txt',
-            'examples/Notebooks/*.ipynb',
             'examples/Notebooks/*.ipynb']
     }
 )

setup.py

@@ -116,9 +116,9 @@
 
 """
 # -*- coding: utf-8 -*-
-from .doc import install_doc
-from . import elast
-from . import conf
-from . import utils
-from . import wiggle
-from .rmat_f import *
+# from .doc import install_doc
+# from . import elast
+# from . import conf
+# from . import utils
+# from . import wiggle
+# from .rmat_f import *