version 0.1.9

Author: amirbricolage

README.md

@@ -6,7 +6,8 @@
 [![Downloads](https://static.pepy.tech/personalized-badge/pyfwi?period=total&units=none&left_color=grey&right_color=green&left_text=Downloads)](https://pepy.tech/project/pyfwi)
 <img src="https://visitor-badge.laobi.icu/badge?page_id=pyfwi_unique12.pyfwi_unique12"/>
 
-This repository contains Python package for elastic seismic full-waveform inversion (FWI).
+This repository contains Python package for elastic seismic full-waveform inversion (FWI) and time-lapse FWI.
+
 
 ## Installation
 To install this package, run 
@@ -19,10 +20,8 @@ py -m pip install PyFWI
 ```
 on Windows.
 
-The structure and requirements of PyFWI can be shown as
-<!-- <center>
-<img alt="PyFWI_structure" src='docs/pyfwi_structure.png' style="width: 400px;">
-</center> -->
+The structure of PyFWI can be shown as
+
 ![PyFWI_structure](docs/pyfwi_structure.png)
 
 ## Citing PyFWI

docs/conf.py

@@ -20,7 +20,7 @@
 project = 'PyFWI'
 copyright = '2022, Amir Mardan'
 author = 'Amir Mardan'
-release = '0.1.8'
+release = '0.1.9'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/PyFWI.rst

@@ -11,6 +11,7 @@ PyFWI.acquisition module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.fwi module
 ----------------
@@ -19,6 +20,7 @@ PyFWI.fwi module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.fwi\_tools module
 -----------------------
@@ -27,6 +29,7 @@ PyFWI.fwi\_tools module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.grad\_switcher module
 ---------------------------
@@ -35,6 +38,7 @@ PyFWI.grad\_switcher module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.model\_dataset module
 ---------------------------
@@ -43,6 +47,7 @@ PyFWI.model\_dataset module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.optimization module
 -------------------------
@@ -51,6 +56,7 @@ PyFWI.optimization module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.processing module
 -----------------------
@@ -59,6 +65,7 @@ PyFWI.processing module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.rock\_physics module
 --------------------------
@@ -67,6 +74,7 @@ PyFWI.rock\_physics module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.seiplot module
 --------------------
@@ -75,6 +83,7 @@ PyFWI.seiplot module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.seismic\_io module
 ------------------------
@@ -83,6 +92,7 @@ PyFWI.seismic\_io module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.tl\_fwi module
 --------------------
@@ -91,6 +101,7 @@ PyFWI.tl\_fwi module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.torchfwi module
 ---------------------
@@ -99,6 +110,7 @@ PyFWI.torchfwi module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.version module
 --------------------
@@ -107,6 +119,7 @@ PyFWI.version module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 PyFWI.wave\_propagation module
 ------------------------------
@@ -115,6 +128,7 @@ PyFWI.wave\_propagation module
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 Module contents
 ---------------
@@ -123,3 +137,4 @@ Module contents
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:

docs/sub_doc/inversion.rst

@@ -9,10 +9,12 @@ Full-waveform inversion
 
 .. autoclass:: PyFWI.fwi.FWI
     :special-members: __call__
+    :noindex:
 
 
 Time-lapse full-waveform inversion
 ==================================
 
 .. autoclass:: PyFWI.tl_fwi.TimeLapse
     :special-members: __call__
+    

setup.py

@@ -6,9 +6,9 @@
     long_description = fh.read()
 
 setup(name='PyFWI',
-      version='0.1.8',
+      version='0.1.9',
       packages=['PyFWI'],
-      description='The initial package for seismic FWI', 
+      description='PyFWI is a Pyhton package for seismic FWI and reservoir monitoring', 
       long_description=long_description,
       long_description_content_type="text/markdown",
       author='Amir Mardan',

src/PyFWI/tl_fwi.py

@@ -143,7 +143,7 @@ def tl_fprime(self, x, freq, k, n_params):
         """
         This function calculate the gradient of cost function
 
-        Parameters:
+        Parameters
         -----------
         x: float32
             This matrix with the shape of [number of parameters, nz*nx] contains

src/PyFWI/torch/wave_propagation.py

@@ -7,7 +7,7 @@
 import PyFWI.fwi_tools as tools
 import PyFWI.acquisition as acq
 from PyFWI.processing import prepare_residual
-from PyFWI.grad_swithcher import grad_lmd_to_vd
+from PyFWI.grad_switcher import grad_lmd_to_vd
 
 class Fdm:
     def __init__(self, order):

src/PyFWI/version.py

@@ -1 +1 @@
-version = '0.1.8'
+version = '0.1.9'