Added Readme files to all libraries. Description in most cases moved from Makefile or

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.
copied from doxygen.txt corrected one Copying file and edited some
existing README files.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 5204
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c

src/libs/libdatrwxx/README

+this is <README>
+============================================================================
+DATRWXX --- seismic data file reading and writing
+-------------------------------
+$Id$
+============================================================================
+
+The library provides seismic data file reading and writing
+modules for several data formats. 
+Functionality for all formats is provided through a common interface defined
+in classes datrw::idatstream and datrw::odatstream.
+All format specific classes are derived from these bases.
+The class datrw::ianystream has a same common interface like
+datrw::idatstream
+but provides an inheritance transparent constructor mechanism.
+The same is the case for datrw::oanystream and datrw:odatstream.
+Programs making use of datrw::ianystream and of datrw::oanystream
+for reading seismic data will
+directly benefit from each additional waveform format added to libdatrwxx
+without the need of changing the source code of the library. 
+Just link against libdatrwxx and go...
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libemod/README

+this is <README>
+============================================================================
+EMOD  --- compile earth model library 
+-------------------------------
+$Id$
+============================================================================
+
+
+
+
+----- END OF README ----- 

src/libs/libfapidxx/COPYING

@@ -11,7 +11,7 @@ Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach)
 
 The source code and other files in this directory are part of libfapidxx 
 which compiles to the binary libraries libfapidxx.a and libfapidxx.so. 
-Fortran API to libdatreadxx and libdatwritexx.
+Fortran API to libdatrwxx.
 
 
 libfapidxx is free software; you can redistribute it and/or modify

src/libs/libfapidxx/README

+this is <README>
+============================================================================
+FAPIDXX --- Fortran API to libdatrwxx
+-------------------------------
+$Id$
+============================================================================
+
+The aim of this library is to provide Fortran 77 code written to be linked
+against libsff.a with the full functionality in libdatrwxx.a.
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libfourier/README

+this is <README>
+============================================================================
+FOURIER --- Fourier coefficients library
+-------------------------------
+$Id$
+============================================================================
+
+The library provides modules to perform Fourier transformations and to operate
+on Fourier transforms.
+An interface to FFTW is available.
+Signal filters can be defined by their Fourier domain response function and
+applied to the Fourier transform of a signal.
+libaff is used to store Fourier coefficients and time series samples.
+Further stuff will be collected in this library in the future.
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libgrrefsub/README

+this is <README>
+============================================================================
+GRREFSUB  --- reflectivity code by J. Ungerer 
+-------------------------------
+$Id$
+============================================================================
+
+provides an API such that reflectivity can be used within programs like
+gremlin or syg.
+
+
+----- END OF README ----- 

src/libs/libgsexx/README

+this is <README>
+============================================================================
+GSEXX --- GSE++ library to read and write GSE waveforms 
+-------------------------------
+$Id$
+============================================================================
+
+The library defines a module GSE2::waveform. This module containes classes
+(TWID2, TCHK2) that hold %GSE2 format elements and can handle their input
+and output to data files. Further it contains functions to read and write
+waveform data in subformat CM6.
+A major advantage of the design of this module is, that it supports sample
+by sample reading and writing.
+The library does not need or use an intermediate character buffer for
+encoding or decoding waveform data in CM6 format.
+
+The library has the primary purpose to supply the CM6 time series
+input/output layer for reading and writing SFF data. But it is designed to
+be supplemented with other %GSE2.1 elements and functionality in the future.
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/liblinearxx/README

+this is <README>
+============================================================================
+LINEARXX ---  provide access to LAPACK for AFF modules 
+-------------------------------
+$Id$
+============================================================================
+
+This library provides a C++ interface to LAPACK. It uses libaff arrays to 
+store matrix data. The library builds a framework to be extended in the 
+future with further interface functions to LAPACK.
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libpgplot++/README

+this is <README>
+============================================================================
+PGPLOT++ --- C++ interface for PGPLOT 
+-------------------------------
+$Id$
+============================================================================
+
+This provides a C++ interface to the FORTRAN PGPLOT library. It is based on 
+the C-interface (cpgplot.h) coming with the library.
+
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/librheology/README

+this is <README>
+============================================================================
+RHEOLOGY --- rheology library 
+-------------------------------
+$Id$
+============================================================================
+
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libseife/Makefile

@@ -5,6 +5,8 @@
 # 25/10/2000 by Thomas Forbriger (IMGF Frankfurt)
 # 
 # libseife Makefile
+# 
+# seife: seismic waveform filters
 #
 # ----
 # This program is free software; you can redistribute it and/or modify
@@ -22,28 +24,7 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 # ----
 #
-# seife: seismic waveform filters
-# ===============================
-#
-# This library contains code which was extracted from the program seife.f
-# by Erhard Wielandt. The original version was written in 1984 at ETH Zurich.
-# The code can be obtained through 
-# http://www.software-for-seismometry.de/
-#
-# The frontpage of http://www.software-for-seismometry.de/ tells (Jan. 2013):
-#
-#   Welcome to Erhard Wielandt's website for free seismological software
-#
-#   This website offers free software for practical use, especially for the
-#   design, calibration, and testing of seismographs. It also contains
-#   educational software and other material used in courses and workshops on
-#   seismometry. Special problems of seismometry and theoretical seismology are
-#   treated in the 'misc. texts'.
-#   If you are interested in software, please start from the software overview. 
-#
-# The code from seife.f was extracted to a library by Wolfgang Friederich in
-# 1996. The current version of libseife is a an extended code collection based
-# on the abovementioned code.
+#=============================================================================
 #
 # Installation
 # ------------

src/libs/libseife/README

+this is <README>
+============================================================================
+SEIFE --- seismic waveform filters
+-------------------------------
+$Id$
+============================================================================
+
+This library contains code which was extracted from the program seife.f
+by Erhard Wielandt. The original version was written in 1984 at ETH Zurich.
+The code can be obtained through
+http://www.software-for-seismometry.de/
+
+The frontpage of http://www.software-for-seismometry.de/ tells (Jan. 2013):
+
+Welcome to Erhard Wielandt's website for free seismological software
+
+This website offers free software for practical use, especially for the
+design, calibration, and testing of seismographs. It also contains
+educational software and other material used in courses and workshops on
+seismometry. Special problems of seismometry and theoretical seismology are
+treated in the 'misc. texts'.
+If you are interested in software, please start from the software overview.
+
+The code from seife.f was extracted to a library by Wolfgang Friederich in
+1996. The current version of libseife is a an extended code collection based
+on the abovementioned code.
+
+
+
+----- END OF README ----- 

src/libs/libserialxx/README

+this is <README>
+============================================================================
+SERIALXX --- a small library to access serial ports in C++
+-------------------------------
+$Id$
+============================================================================
+
+This library was initiated to provide access to our Thies pluviograph
+(rainfall recorder) at BFO.
+It will first provide only features required together with this instrument.
+The general design, however, supports more general usage in the future.
+
+The main interface is the SerialPort class.
+It supports opening of a serial port, port parameter configuration, and
+reading and writing from and to the port.
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libsff/Makefile

@@ -4,7 +4,7 @@
 # 
 # Copyright (c) 2003 by Thomas Forbriger (BFO Schiltach) 
 # 
-# libsff
+# libsff: Stuttgart File Format I/O Fortran software library
 #
 # ----
 # This program is free software; you can redistribute it and/or modify
@@ -22,12 +22,6 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 # ----
 #
-# libsff: Stuttgart File Format I/O Fortran software library
-# ==========================================================
-#
-# This library provides subroutines in Fortran 77 to read and write seismic
-# time series to files in Stuttgart File Format (SFF).
-#
 # Installation instructions
 # -------------------------
 # The command

src/libs/libsff/README

-libsff
-======
+this is <README>
+============================================================================
+SFF --- Stuttgart File Format I/O Fortran software library
+-------------------------------
+$Id$
+============================================================================
 
 This is a library containing some fortran subroutines to read and write
 data in SFF (Stuttgart File Format) which is based on GSE2.0. This
@@ -15,4 +19,8 @@ libsff.doc        contains a quick reference to the routines in the library
 
 C prototypes are provided in sff.h for C-code which links against this library.
 
-For installation instruction and dependencies see Makefile
+For installation instruction see Makefile
+
+
+
+----- END OF README ----- 

src/libs/libsffu/README

+this is <README>
+============================================================================
+SFFU --- create some little helpers for SFF data manipulation 
+-------------------------------
+$Id$
+============================================================================
+
+
+
+
+----- END OF README ----- 

src/libs/libsffxx/Makefile

@@ -4,7 +4,7 @@
 # 
 # Copyright (c) 2003 by Thomas Forbriger (BFO Schiltach) 
 # 
-# C++ SFF code
+# SFF++ library: reading and writing SFF from C++
 #
 # ----
 # libsffxx is free software; you can redistribute it and/or modify
@@ -22,27 +22,6 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 # ----
 #
-# SFF++ library: reading and writing SFF from C++
-# ===============================================
-#
-# The library is designed to provide a tool for SFF (Stuttgart File Format)
-# writing and reading. It uses libgsexx for the GSE2 layer of SFF. While
-# libgsexx does not explicitely use an array class for time series, libsffxx
-# provides whole array reading and writing functionality. For this purpose
-# the library uses code from libaff.
-#
-# A major advantage of the library is a feature of libgsexx. With this code
-# you can deal with time series of arbitrary length. In particular no
-# temporary character buffer for CM6 decoding and encoding is needed (like it
-# is in the Fortran library). This means, on the other hand, that the library
-# has no information to fill the nchar field of the DAST line.
-#
-# Warning:
-#     The library will write -1 to the nchar field of the DAST line. You will
-#     need an updated version (2.00 or higher) of libstuff or libsff (Fortran
-#     version) to read data files written with libsffxx to Fortran code. 
-#
-# See the doxygen generated documentation for details.
 #
 # Installation instructions
 # -------------------------

src/libs/libsffxx/README

+this is <README>
+============================================================================
+SFFXX --- reading and writing SFF from C++
+-------------------------------
+$Id$
+============================================================================
+
+The library is designed to provide a tool for SFF (Stuttgart File Format)
+writing and reading. It uses libgsexx for the GSE2 layer of SFF. While
+libgsexx does not explicitely use an array class for time series, libsffxx
+provides whole array reading and writing functionality. For this purpose
+the library uses code from libaff.
+
+A major advantage of the library is a feature of libgsexx. With this code
+you can deal with time series of arbitrary length. In particular no
+temporary character buffer for CM6 decoding and encoding is needed (like it
+is in the Fortran library). This means, on the other hand, that the library
+has no information to fill the nchar field of the DAST line.
+
+Warning:
+The library will write -1 to the nchar field of the DAST line. You will
+need an updated version (2.00 or higher) of libstuff or libsff (Fortran
+version) to read data files written with libsffxx to Fortran code. 
+
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libstfinv/README

+this is <README>
+============================================================================
+STFINV --- create library for source wavelet correction filter determination
+-------------------------------
+$Id$
+============================================================================
+
+The purpose of this library is to provide methods for the derivation of
+source wavelet correction filters
+in approaches to full waveform inversion.
+Given a set of recorded data and a set of synthetic data (typically,
+but not necessarilly the impulse response of the subsurface) a source
+wavelet correction filter
+is obtained due to some optimization citerion.
+The synthetic waveforms are convolved with this filter
+wavelet and the convolved
+synthetics as well as the wavelet itself are returned to the user.
+
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
+----- END OF README ----- 

src/libs/libtfxx/README

@@ -14,4 +14,7 @@ http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/libs/libtfxx
 Please send bug reports and suggestions to
 Thomas.Forbriger@kit.edu
 
+Detailed documentation is provided through doxygen source code. See target
+doxydoc in the Makefile.
+
 ----- END OF README -----