ASKI main package

ASKI is a highly modularized program suite offering sensitivity and regularization analysis tools for seismic datasets as well as a scattering-integral-type full waveform inversion concept based on waveform sensitivity (Fréchet) kernels derived from Born scattering theory (Gauss-Newton convergence). ASKI does not implement an intrinsic code for simulation of seismic wave propagation but instead comes with support for several external forward codes for 1D and 3D background media in spherical and Cartesian framework, at the moment SPECFEM3D_Cartesian, SPECFEM3D_GLOBE, Gemini II and NEXD.

Authors and License

ASKI and some of its components, as well as documentation and some examples are available under terms of the GNU General Public License (version 2 or higher) on github. Please find contact addresses there, or visit http://www.rub.de/aski in case you want to get in touch with the authors. If you encounter any problems installing or using the software, it will be helpful to open (or add to) an "issues" topic at the github repository.

The main authors are Florian Schumacher and Wolfgang Friederich (Ruhr-University Bochum, Germany).

Documentation

Please refer to documents in doc/ :

the ASKI user manual
Florian Schumacher's doctoral dissertation about waveform sensitivity kernels and the modularized iterative full waveform inversion concept on which ASKI is based
the accepted version of our GJI 2016 paper, re-typeset in a standard layout
our SoftwareX 2016 paper,
published as Open Access under the CC BY license

Toy examples

Any files packages for the ASKI toy examples, as described in the manual (chapter 0 ASKI workflows) are attached to release 1.0 of the ASKI main package. These inversion examples use release version 1.0 of the extension packages SPECFEM3D_Cartesian and SPECFEM3D_GLOBE, respectively.

Requirements

GNU Make
Fortran compiler (sufficient standard, so far tested: GNU Fortran (Ubuntu 5.4.0-6ubuntu1~16.04.2) 5.4.0 20160609)
BLAS and LAPACK libraries for all applications
BLACKS, SCALAPACK and MPI libraries optionally for few parallel applications (e.g. available via netlib.org/)

Installation

If not yet done, you should downloade the source code of the ASKI main package by either
- cloning the master branch of the ASKI repository on gitHub.com:
```
git clone --depth 1 --branch master https://github.com/seismology-RUB/ASKI
```
- or downloading a zipped version of the source code from there:
```
wget https://github.com/seismology-RUB/ASKI/archive/master.zip
```
  The directory to where you have cloned/extracted the master branch, will in the following be referred to as ASKI/
Adjust the software to your system and personal requirements by:
- setting the variables COMPILER, MPICOMPILER in file ASKI/Makefile appropriately
- setting the variables BLAS, LAPACK, (BLACS, SCALAPACK, MPILIB) in file ASKI/Makefile in order to correctly bind required libraries
- adjusting the variable FFLAGS in file ASKI/Makefile, if required
Run command
```
make all
```
from installation path ASKI/ to compile all serial programs (nearly all functionality)
Run command
```
make parallel
```
from installation path ASKI/ to compile all parallel programs (two optional linear system solvers which run in parallel)

Now ASKI/bin should contain all binaries and no error should have occurred (at best...).

Usage

Refer to the user manual for any details on using ASKI.

LongyanU / ASKI