Skip to content

Commit 03f8403

Browse files
authored
use renamed folder in README.md
1 parent 1742cc2 commit 03f8403

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ and Romain Brossier. Minor changes to the original code have been made to allow
1313

1414
The SEISCOPE toolbox uses a derived data type (`optim`); functionality that is not yet supported at this time by f2py - and for this reason it is used [ctypes](https://docs.python.org/3/library/ctypes.html). The `optim` data type is maintained, but without allocatable arrays.
1515

16-
The repo contains a `src` directory with the modified fortran source files and a subdirectory `tests` where each method is used to find the minimum of the banana Rosenbrock function. The python wrapper for the SEISCOPE optimization toolbox is found inside the `seiscope_opt_tb_wrapper` directory. A `tests` directory (different from than one within `src`) includes a script to check that the wrapper has suceeded in reproducing bit-for-bit the results of the original fortran code.
16+
The repo contains a `src` directory with the modified fortran source files and a subdirectory `tests` where each method is used to find the minimum of the banana Rosenbrock function. The python wrapper for the SEISCOPE optimization toolbox is found inside the `sotb_wrapper` directory. A `tests` directory (different from than one within `src`) includes a script to check that the wrapper has suceeded in reproducing bit-for-bit the results of the original fortran code.
1717

1818
Compiling
1919
-----
@@ -25,7 +25,7 @@ FoBiS.py build -f seiscope_opt_toolbox_w_ctypes.fobis -mode shared-gnu
2525
```
2626
It is also possible to build the library in static form and the `tests` programs by changing the `mode` flag. The full set of modes are: `static-gnu`, `static-gnu-debug`, `static-intel`, `static-intel-debug`, `shared-gnu`, `shared-gnu-debug`, `shared-intel`, `shared-intel-debug`, `tests-gnu`, `tests-gnu-debug`, `tests-intel`, `tests-intel-debug`. The modes should be self-explanatory: shared, static and tests are the modes for building (in realese, optimized form) the shared and static versions of the library and the test programs, respectively. The other 3 modes are the same, but in debug form instead of release one. -gnu use the GNU gfortran compiler while -intel the Intel one.
2727

28-
A simple bash script `build.sh` is also provided for building the seiscope optimization toolbox with gfortran using [FoBiS](https://github.com/szaghi/FoBiS). It creates the library in static form, as originally designed as well as the tests programs.
28+
A simple bash script `build.sh` is also provided for building the seiscope optimization toolbox with gfortran using [FoBiS](https://github.com/szaghi/FoBiS). It creates the library in static form, as originally designed as well as the tests programs. This option can be used if the user is only interested in the fortran librray.
2929

3030
Install sotb-wrapper
3131
-----
@@ -41,11 +41,11 @@ pip install -e .
4141
Usage
4242
-----
4343

44-
Example run scripts are included in the [`seiscope_opt_tb_wrapper/examples`](https://github.com/ofmla/seiscope_opt_toolbox_w_ctypes/tree/main/seiscope_opt_tb_wrapper/examples) subdirectory. The examples can be run after the shared object has been built to test that wrapper works as it should. Note that you must have [Devito](https://www.devitoproject.org/) in order to be able to run the examples. A python script `plot_curves.py` is also provide in the `examples` directory. Please note that it may not be the best implementation and is intended for illustrative purposes only. The following figures were obtained with the `plot_curves.py` script after ran one of the examples (`lsrtm_aniso.py`).
44+
Example run scripts are included in the [`sotb_wrapper/examples`](https://github.com/ofmla/seiscope_opt_toolbox_w_ctypes/tree/main/sotb_wrapper/examples) subdirectory. The examples can be run after the shared object has been built to test that wrapper works as it should. Note that you must have [Devito](https://www.devitoproject.org/) in order to be able to run the examples. A python script `plot_curves.py` is also provide in the `examples` directory. Please note that it may not be the best implementation and is intended for illustrative purposes only. The following figures were obtained with the `plot_curves.py` script after ran one of the examples (`lsrtm_aniso.py`).
4545

4646
<img src="./sotb_wrapper/examples/computationalcost_curves.svg" width="425"/> <img src="./sotb_wrapper/examples/convergence_curves.svg" width="425"/>
4747

48-
A tutorial in the form of a Jupyter notebook (`rosenbrock.ipynb`) is also supplied. The goal of the tutorial is show you how one can use sotb-wrapper to find a minimum for a problem, which can optionally be subject to bound constraints (also called box constraints). You can also find a simple example on calling the Fortran subroutines from a C main program in the [`c_code`](https://github.com/ofmla/seiscope_opt_toolbox_w_ctypes/tree/main/seiscope_opt_tb_wrapper/examples/c_code) directory. The example uses the Limited-memory Broyden-Fletcher-Goldfarb-Shanno (L-BFGS) algorithm to minimize the Rosenbrock's "banana function".
48+
A tutorial in the form of a Jupyter notebook (`rosenbrock.ipynb`) is also supplied. The goal of the tutorial is show you how one can use sotb-wrapper to find a minimum for a problem, which can optionally be subject to bound constraints (also called box constraints). You can also find a simple example on calling the Fortran subroutines from a C main program in the [`c_code`](https://github.com/ofmla/seiscope_opt_toolbox_w_ctypes/tree/main/sotb_wrapper/examples/c_code) directory. The example uses the Limited-memory Broyden-Fletcher-Goldfarb-Shanno (L-BFGS) algorithm to minimize the Rosenbrock's "banana function".
4949

5050
License
5151
-----

0 commit comments

Comments
 (0)