Skip to content

Commit

Permalink
update docs and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
AmirMardan committed Nov 5, 2024
1 parent 6bac3e4 commit d79f774
Show file tree
Hide file tree
Showing 7 changed files with 240 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
project = 'PyFWI'
copyright = '2022, Amir Mardan'
author = 'Amir Mardan'
release = '0.1.9'
release = '0.1.10'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
3 changes: 1 addition & 2 deletions docs/sub_doc/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,7 @@ Then we need to create an input dictionary as follow
't': 0.8, # Length of operation
'npml': 20, # Number of PML
'pmlR': 1e-5, # Coefficient for PML (No need to change)
'pml_dir': 2, # type of boundary layer
'device': 1, # The device to run the program. Usually 0: CPU 1: GPU
'pml_dir': 2, # type of boundary layer
}
seisout = 0 # Type of output 0: Pressure
Expand Down
1 change: 0 additions & 1 deletion docs/sub_doc/fwi_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ Then we need to create an input dictionary as follow
'npml': 20, # Number of PML
'pmlR': 1e-5, # Coefficient for PML (No need to change)
'pml_dir': 2, # type of boundary layer
'device': 1, # The device to run the program. Usually 0: CPU 1: GPU
}
seisout = 0 # Type of output 0: Pressure
Expand Down
3 changes: 1 addition & 2 deletions docs/sub_doc/grad_pytorch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,7 @@ Then we need to create an input dictionary as follow
'npml': 20, # Number of PML
'pmlR': 1e-5, # Coefficient for PML (No need to change)
'pml_dir': 2, # type of boundary layer
'device': 1, # The device to run the program. Usually 0: CPU 1: GPU
'seimogram_shape': '3d',
'seimogram_shape': '3d'
}
seisout = 0 # Type of output 0: Pressure
Expand Down
18 changes: 6 additions & 12 deletions example/grad_pytorch.ipynb

Large diffs are not rendered by default.

237 changes: 230 additions & 7 deletions example/tlfwi_example_crosswell.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
long_description = fh.read()

setup(name='PyFWI',
version='0.1.9',
version='0.1.10',
packages=['PyFWI'],
description='PyFWI is a Pyhton package for seismic FWI and reservoir monitoring',
long_description=long_description,
Expand Down

0 comments on commit d79f774

Please sign in to comment.