HOWTO install the software from Seitosh
Obtaining the source code
Either download a snapshot tar-ball
Snapshot tar-balls are available for anonymous download at https://git.scc.kit.edu/Seitosh/Seitosh/tree/master (see drop-down menu 'Download zip' at the top right)
- Download the tar-ball of interest.
- Extract the contents of the tar-ball.
- Explore the extracted files as well as the README files coming along with them.
Or create a clone of the git repository
This requires an appropriate account and therefore usually is only available to members of the institute at KIT.
-
Create a git clone
For anonymous users:git clone https://git.scc.kit.edu/Seitosh/Seitosh.git
For users authenticated at git.scc.kit.edu:
git clone git@git.scc.kit.edu:Seitosh/Seitosh.git
-
Explore the working copy and the README files therein. See INSTALL.md for installation instructions.
Preparing for installation of binary programs
-
Read the basic information given in INSTALL.md
-
The Makefiles in this repository make extensive use of shell environment variables in order to use appropriate paths for include files, binary libraries, binary executables and so on...
-
Depending on the software modules you would like to install, you will have to install additional libraries. The required libraries are indicated in README files in the particular subdirectory of Seitosh.
External libraries currently used are:- boost
- LAPACK
- BLAS
- GLS
- FFTW3
- PGPLOT (PGPLOT in turn requires the X11 header files, provided in the X11 development package)
Remarks:
- OpenSuSE offers all of them except PGPLOT. Other Linux distributions will do as well.
- Since some of the libraries in the repository require header files from the external libraries in order to be installed properly (even if you do not intend to use these components), I strongly recommend to install all of the external libraries.
- '''Notice: Not only the binary libraries are required but also the associated C and C++ header files'''. OpenSuSE offers the header files in separate packages (called ''devel''-packages). They must be installed in addition to the binary library packages.
- Some distributions offer pre-compiled packages for PGPLOT, which just
have to be installed.
If your system does not offer PGPLOT, you have to compile PGPLOT
yourself.
Please have a look at the wiki page
on installtion of PGPLOT.
You will require the
libcpgplot.a
and the header filecpgplot.h
in appropriate locations. You will also require a copy oflibpgplot.so
in$LOCLIBDIR
(see below).
-
Check your compilers. Required are:
-
If you like to rebuild the online documentation from the source code, you should install doxygen additionally.
-
The shell script checklibs.sh provides a check for installed packages on openSuSE systems.
-
Install SeitoshBashrc as
~.SeitoshBashrc
:test@fenoglio:~> cd Seitosh/contrib test@fenoglio:~/Seitosh/contrib> cp -vpd SeitoshBashrc ~/.SeitoshBashrc
SeitoshBashrc' ->
/home/test/.SeitoshBashrc' test@fenoglio:~/Seitosh/contrib> -
Edit
~/.SeitoshBashrc
to adjust the entries to match your requirements. A detailed description of their meaning is given in README.compile. -
Activate
~/.SeitoshBashrc
by placing the linetest -s ~/.SeitoshBashrc && . ~/.SeitoshBashrc || true
at the end of your
~/.bashrc
-
Log out and log in again, to make new settings available in the current session.
-
Create the required directories:
mkdir -pv $LOCBINDIR $LOCLIBDIR $LOCINCLUDEDIR
-
Make sure, that a copy of
cpgplot.h
is installed in$LOCINCLUDEDIR
and that a copy oflibpgplot.so
is installed in$LOCLIBDIR
.
Compiling the source code
Compilation of the source code is supported by the shell script src/compile.sh. Use
src/compile.sh install --pause
to install binary programs and
src/compile.sh doc --pause
to prepare the source code documentation. Running
src/compile.sh clean --pause
removes temporary files from the source tree and
src/compile.sh --help
provide additional usage information.
Using the programs
-
Have a look at the binary executables available:
test@fenoglio:~> ls $LOCBINDIR any2ascii anyindex listsff sff2ascii stuplo any2sff damplo pamo sffextract stuploxx anyextract gse2sff refract splot susplo
-
All programs come with a compiled in help function. You simply check what the program offers:
test@fenoglio:~> refract REFRACT V4.7 REFRACTion seismics - data interpretation
Usage: refract src/doz/misc[-D] [-d dev] [-v] [-p] [-Tt title] [-Tx label] [-Ty label] [-Tm T|F] [-Ta label] [-Tl T|F] [-Ts factor] [-TM t,x] [-Lw width] [-Lc] [-Lm max] [-Lt width] [-Cb r,g,b] [-Cf r,g,b] [-CW] [-Cc] [-Cm max] [-Eg] [-Ev] [-Eb] [-EP T|F] [-ES T|F] [-ET T|F] [-En] [-Es] [-Ew T|F] [-Et T|F] [-Ep T|F] [-Fp file] [-Fa file] [-Ft file] [-Fm file] [-Sx x1,x2] [-St t1,t2] [-Se exp] [-Sa lev] [-Sc lev] [-Sm mode] [-Sr vel] [-Si] [-SM] [-SR radius] [-SO minoff] [-Sh] [-C] [-L] [-R radius] [-O minoff] file [t:n,n-n] [o:s] [s:i,s,w] [n:name] [h:h,l,s] [r:r,g,b] [file ...] or: refract -help STOP ERROR: missing argumentsor the detailed information:
test@fenoglio:~> refract -help ...
-
There exists a (still incomplete) directory of available programs.