Merge pull request #3 from jpvantassel/dev

In preparation for v1.0.0rc0

.circleci/config.yml

@@ -1,15 +1,32 @@
-version: 2
+version: 2.1
+
+orbs:
+  coverage-reporter: codacy/coverage-reporter@7.6.7
+  codecov: codecov/codecov@1.0.2
+
 workflows:
-  version: 2
-  test:
+  build:
     jobs:
-      - test-3.6
-      - test-3.7
-      - test-3.8
+      - test-36:
+          context:
+            - docker          
+      - test-37:
+          context:
+            - docker
+      - test-38:
+          context:
+            - docker
+      - test-39:
+          context:
+            - docker
+
 jobs:
-  test-3.6: &test-template
+  test-36: &test-template
     docker:
-      - image: circleci/python:3.6.9
+      - image: circleci/python:3.6.14
+        auth:
+          username: jpvantassel
+          password: $DOCKER_PASS
     working_directory: ~/repo
     steps:
       - checkout
@@ -29,30 +46,42 @@ jobs:
           command: |
             . venv/bin/activate
             cd test
-            coverage run --source=../swprepost -m unittest
+            coverage run --source=../swprepost --omit=*/testtools.py,*/test_*.py -m unittest
       - run:
           name: Create coverage xml
           command: |
             . venv/bin/activate
             mv test/.coverage test-results
             cd test-results
-            coverage xml -o coverage.xml
+            coverage xml -o cobertura.xml
       - store_test_results:
           path: test-results
       - store_artifacts:
           path: test-results
-      - run:
-          name: Call Codecov
-          command: |
-            . venv/bin/activate
-            pip install codecov
-            codecov
+      - codecov/upload:
+          file: test-results/cobertura.xml
+      - coverage-reporter/send_report
 
-  test-3.7:
+  test-37:
     <<: *test-template
     docker:
-      - image: circleci/python:3.7.5
-  test-3.8:
+      - image: circleci/python:3.7.11
+        auth:
+          username: jpvantassel
+          password: $DOCKER_PASS
+
+  test-38:
+    <<: *test-template
+    docker:
+      - image: circleci/python:3.8.11
+        auth:
+          username: jpvantassel
+          password: $DOCKER_PASS
+
+  test-39:
     <<: *test-template
     docker:
-      - image: circleci/python:3.8.0
+      - image: circleci/python:3.9.6
+        auth:
+          username: jpvantassel
+          password: $DOCKER_PASS

LICENSE.txt

@@ -1,6 +1,6 @@
-This license applies to SWprepost a Python package for Surface-Wave
+This license applies to swprepost a Python package for Surface Wave
 Inversion Pre- and Post-processing.
-Copyright (C) 2019-2020 Joseph P. Vantassel (jvantassel@utexas.edu)
+Copyright (C) 2019-2021 Joseph P. Vantassel (jvantassel@utexas.edu)
 
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007

README.md

@@ -1,4 +1,4 @@
-# SWprepost - A Python Package for Surface Wave Inversion Pre- and Post-Processing
+# _swprepost_ - A Python Package for Surface Wave Inversion Pre- and Post-Processing
 
 > Joseph P. Vantassel, The University of Texas at Austin
 
@@ -13,16 +13,16 @@
 
 ---
 
-- [About _SWprepost_](#About-SWprepost)
+- [About _swprepost_](#About-swprepost)
 - [A Few Examples](#A-Few-Examples)
 - [Getting Started](#Getting-Started)
 
-## About _SWprepost_
+## About _swprepost_
 
 ---
 
-`SWprepost` is a Python package for performing surface wave inversion pre- and
-post-processing. `SWprepost` was developed by Joseph P. Vantassel under the
+_swprepost_ is a Python package for performing surface wave inversion pre- and
+post-processing. _swprepost_ was developed by Joseph P. Vantassel under the
 supervision of Professor Brady R. Cox at The University of Texas at Austin. The
 package includes 11 class definitions for interacting with the various
 components required for surface wave inversion. It is designed to integrate
@@ -32,24 +32,24 @@ inversion programs. Furthermore, some of the class definitions provided such as
 `GroundModel` may even be of use to those working in the Geotechnical or
 Geophysical fields, but who do not perform surface wave inversions.
 
-If you use `SWprepost` in your research or consulting we ask you please cite the
+If you use _swprepost_ in your research or consulting we ask you please cite the
 following:
 
 > Joseph Vantassel. (2020). jpvantassel/swprepost: latest (Concept). Zenodo.
 > http://doi.org/10.5281/zenodo.3839998
 
 _Note: For software, version specific citations should be preferred to general_
 _concept citations, such as that listed above. To generate a version specific_
-_citation for `SWprepost`, please use the citation tool for that specific_
-_version on the `SWprepost` [archive](https://doi.org/10.5281/zenodo.3839998)._
+_citation for `swprepost`, please use the citation tool for that specific_
+_version on the `swprepost` [archive](https://doi.org/10.5281/zenodo.3839998)._
 
-For the motivation behind the development of `SWprepost` and its role in a
+For the motivation behind the development of _swprepost_ and its role in a
 larger project focused on developing a complete and rigorous workflow for
 surface wave inversion please refer to and consider citing the following:
 
-> Vantassel, J.P., Cox, B.R., (2020). SWinvert: A workflow for performing
-> rigorous 1D surface wave inversions. Geophysical Journal International
-> (Accepted) https://doi.org/10.1093/gji/ggaa426
+> Vantassel, J.P. and Cox, B.R. (2021). SWinvert: a workflow for performing
+> rigorous 1-D surface wave inversions. Geophysical Journal International
+> 224, 1141-1156. https://doi.org/10.1093/gji/ggaa426
 
 ## A Few Examples
 
@@ -110,7 +110,7 @@ plt.show()
 
 ---
 
-### Installing or Upgrading _SWprepost_
+### Installing or Upgrading _swprepost_
 
 1.  If you do not have Python 3.6 or later installed, you will need to do
 so. A detailed set of instructions can be found
@@ -125,21 +125,21 @@ of `swprepost` use `pip install swprepost --upgrade`.
 3.  Confirm that `swprepost` has installed/updated successfully by examining the
 last few lines of text displayed in the console.
 
-### Using _SWprepost_
+### Using _swprepost_
 
 1.  Download the contents of the
-  [examples](https://github.com/jpvantassel/swprepost/tree/master/examples)
+  [examples](https://github.com/jpvantassel/swprepost/tree/main/examples)
   directory to any location of your choice.
 
 2.  Explore the Jupyter notebooks in the
-  [basic](https://github.com/jpvantassel/swprepost/tree/master/examples/basic)
+  [basic](https://github.com/jpvantassel/swprepost/tree/main/examples/basic)
   directory for a no-coding-required introduction to the `swprepost` package.
   If you have not installed `Jupyter`, detailed instructions can be found
   [here](https://jpvantassel.github.io/python3-course/#/intro/installing_jupyter).
 
-3.  Move to the [adv](https://github.com/jpvantassel/swprepost/tree/master/examples/adv)
+3.  Move to the [adv](https://github.com/jpvantassel/swprepost/tree/main/examples/adv)
   directory and follow the Jupyter notebook title `SWinvertWorkflow.ipynb` for
   an example application of `swprepost` to the SWinvert workflow
-  (Vantassel and Cox, 2020).
+  (Vantassel and Cox, 2021).
 
 4.  Enjoy!

docs/conf.py

@@ -15,14 +15,27 @@
 
 sys.path.insert(0, os.path.abspath('../swprepost'))
 
+
+def parse_meta(path_to_meta):
+    with open(path_to_meta) as f:
+        meta = {}
+        for line in f.readlines():
+            if line.startswith("__version__"):
+                meta["__version__"] = line.split('"')[1]
+    return meta
+
+
+meta = parse_meta("../swprepost/meta.py")
+
+
 # -- Project information -----------------------------------------------------
 
 project = 'swprepost'
-copyright = '2019 - 2020, Joseph P. Vantassel'
+copyright = '2019 - 2021, Joseph P. Vantassel'
 author = 'Joseph P. Vantassel'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.0'
+release = meta['__version__'] 
 
 # -- General configuration ---------------------------------------------------
 

docs/index.rst

@@ -2,12 +2,12 @@
    Tue Nov 12 10:00:56 2019. You can adapt this file completely to your
    liking, but it should at least contain the root `toctree` directive.
 
-SWprepost Documentation
+`swprepost` Documentation
 ====================
 
-`SWprepost` is a Python package for surface-wave inversion pre- and
+`swprepost` is a Python package for surface wave inversion pre- and
 post-processing. It includes 12 class definitions to handle all aspect of
-the surface-wave inversion process.
+the surface wave inversion process.
 
 This package and the classes therein are actively being developed, so if you
 do not see a feature you would like it may very well be under development and

docs/make_latex.sh

@@ -4,6 +4,6 @@ sphinx-build -b latex . latex
 
 cd latex
 
-pdflatex hvsrpy.tex
+pdflatex swprepost.tex
 
-pdflatex hvsrpy.tex
+pdflatex swprepost.tex