Merge branch 'master' into devel

bch0w · May 3, 2022 · 7c3fa78 · 7c3fa78
2 parents 8636dc8 + 6533daf
commit 7c3fa78
Show file tree

Hide file tree

Showing 7 changed files with 894 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -8,17 +8,19 @@
 
 ---
 
+SeisFlows3 is a fork of [SeisFlows](https://github.com/rmodrak/seisflows/) and the [current main development branch](https://github.com/rmodrak/seisflows/issues/111) for this codebase. 
+
 SeisFlows is a Python-based waveform inversion package used to tackle the problems of full waveform inversion, seismic migration, and adjoint tomography.  
 
 With a growing user base in academia and industry, this package has been used for production scale inversions, some with over a billion model parameters, for research problems related to oil and gas exploration, earthquake seismology, and general nonlinear optimization problems.                                         
 
-SeisFlows3 is a fork of SeisFlows and the current main development branch. Changes to the package include migration to Python3, updates to source-code readability through improved doc strings and comments, stronger adherance to PEP-8 standards, and additional functionalities not present in the original package.                                                                       
+Changes made in the SeisFlows3 package include code refactor to Python3, improvements in source-code implementation and readability, stronger adherance to coding standards (PEP-8), and additional functionalities not present in the original package.                                                                       
 
 References
 ----------
 If you find this package useful, please cite:
 
-`Ryan Modrak, Dmitry Borisov, Matthieu Lefebvre, JeroenTrompa; SeisFlows—Flexible waveform inversion software, Computers & Geosciences, Volume 115, June 2018, Pages 88-95, https://doi.org/10.1016/j.cageo.2018.02.004`
+`Ryan Modrak, Dmitry Borisov, Matthieu Lefebvre, Jeroen Tromp; SeisFlows—Flexible waveform inversion software, Computers & Geosciences, Volume 115, June 2018, Pages 88-95, https://doi.org/10.1016/j.cageo.2018.02.004`
 
 `Ryan Modrak, Jeroen Tromp; Seismic waveform inversion best practices: regional, global and exploration test cases, Geophysical Journal International, Volume 206, Issue 3, 1 September 2016, Pages 1864–1889, https://doi.org/10.1093/gji/ggw202`