Commit 5746cd26 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[TASK] (install): describe files and directories

add README files to src and contrib
parent 52d00b69
this is <README>
============================================================================
files supporting the installation and development of Seitosh
------------------------------------------------------------
directories
-----------
pgplot
Contains material supporting the installation of the PGPLOT library which
is used by Seitosh.
utilities
Shell scripts supporting users and developers of Seitosh.
files
-----
GPLphrase
License phrase to be used in source code file. This file is used by
contrib/gplphrase
Makefile.buildingblocks
Snippets useful when programming Makefiles
README.style-guide
An incomplete (and hardly respected) style guide for Seitosh.
SeitoshBashrc
A template for the bash rc-file to be included in ~/.bashrc
----- END OF README -----
this is <README>
============================================================================
Seitosh source code directory
-----------------------------
files
-----
compile.sh
Shell script to compile and install all Seitosh components.
Just run compile.sh to receive usage information.
install_src_dirs.txt
List of directories to be addressed by compile.sh for the installation of
Seitosh components.
README.compile
A description of essential steps to take when compiling and installing
Seitosh components.
README.dependencies
A description of internal and external dependencies between Seitosh
components and libraries.
README.make.variables
A detailed description of variables commonly used in Makefile.
directories
-----------
conv
Data file conversion programs. Also contains the ThiesDL1 data recording
program.
green
Programs to apply a Fourier-Bessel transformation or dispersion analysis
to seismic data. These programs come along with plot programs and
utilities. gremlin1 is a program for the inversion of Fourier-Bessel
expansion coefficients and travel times to subsurface structure.
libs
Seitosh software libraries used by the main executables provided in other
directories.
matlab
Code linking Matlab to Seitosh. Currently this directory contains which
provides access to libdatrwxx functions from with in Matlab. This way
various seismic data formats can be read from Matlab script files.
python
Programs written in python. Currently contains only a plot program for
power spectral densities (which should better be placed elsewhere).
synt
Programs calculate synthetic seismic waveforms and travel times. It in
particular contains a reflectivity program.
ts
Various programs to manipulate seismic data files and operate on seismic
data. It contains wave form filter programs, data analysis preprocessing
tools and plot programs.
----- END OF README -----
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment