Commit 3ef61e94 authored by uqchw's avatar uqchw Committed by thomas.forbriger
Browse files

Moved comments (Installation hints, dependencys...) from Makefiles to Readme files

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.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 5218
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent ca971f77
......@@ -37,6 +37,10 @@
# http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
# If it is not available to you, you should set TF_REMCMMNT=cat (see below)
#
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# REVISIONS and CHANGES
# 06/12/2002 V1.0 Thomas Forbriger
# 27/12/2002 V1.1 doxygen reads Fortran code and files generated by f2c
......@@ -54,22 +58,6 @@
# $SERVERINCLUDEDIR
#
# ============================================================================
#
# environment variables
# ---------------------
#
# You will like to set the following environment variables:
#
# LOCINCLUDEDIR Defines the path where header files will be copied for
# usage in your own projects. You will pass this path to
# the precompiler with the -I option.
# LOCLIBDIR Defines the path where the binary library will be
# placed.
# TF_WWWBASEDIR Defines the path to your personal homepage. That's the
# place where doxygen output will be written too (see
# below).
#
# You will find the installed library header files in $(LOCINCLUDEDIR)/aff
.PHONY: all
all: install doc
......
......@@ -14,6 +14,23 @@ small. The array itself is meant to be used to pass numbers from one program
module to the other. If you want to exploit the power of expression templates,
pass the array contents to something like Blitz++.
Installation
------------
environment variables:
LOCINCLUDEDIR Defines the path where header files will be copied for
usage in your own projects. You will pass this path to
the precompiler with the -I option.
LOCLIBDIR Defines the path where the binary library will be
placed.
TF_WWWBASEDIR Defines the path to your personal homepage. That's the
place where doxygen output will be written too (see
below).
make all installs headers, binary libraries and documentation
You will find the installed library header files in $(LOCINCLUDEDIR)/aff
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -25,38 +25,10 @@
# DATRW++ library: seismic data I/O with multiple formats
# =======================================================
#
# 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...
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation
#
# Installation instructions
# -------------------------
# To install the library use target install
#
# To instell the library together with the doxygen documentation,
# use target all. Note that this requires doxygen to be installed.
# The doxygen documentation will be placed in $(DOXYWWWPATH).
#
# The binary library libdatrwxx.a will be placed in $(LOCLIBDIR). The prototype
# files will be copied to $(LOCINCLUDEDIR).
#
# Other libraries that are required to compile libdatrwxx:
# libaff, libgsexx, libtime++, libsffxx
#
# doxygen is required to produce the source code documentation
#
# For test code and examples libtfxx is required in addition.
#
# ----
#
# REVISIONS and CHANGES
# 30/03/2004 V1.0 Thomas Forbriger
# 29/06/2007 V1.1 included SAC binary reading
......
......@@ -20,6 +20,28 @@ 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...
Installation instructions
-------------------------
To install the library use target install
To instell the library together with the doxygen documentation,
use target all. Note that this requires doxygen to be installed.
The doxygen documentation will be placed in $(DOXYWWWPATH).
The binary library libdatrwxx.a will be placed in $(LOCLIBDIR). The prototype
files will be copied to $(LOCINCLUDEDIR).
Other libraries that are required to compile libdatrwxx:
libaff, libgsexx, libtime++, libsffxx
doxygen is required to produce the source code documentation
For test code and examples libtfxx is required in addition.
----
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -25,42 +25,9 @@
# Fourier library: Operations in the Fourier domain
# =================================================
#
# 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.
#
# Binary libraries
# ----------------
# libfourier.a Fortran library
# libfourierxx.a C++ library
#
# Dependencies
# ------------
# libaff is required to compile the binary libraries
# fftw3 is required for the C++ library
# doxygen is required to process source code documentation
#
# Installation
# ------------
# environment variables:
# LOCINCLUDEDIR Defines the path where header files will be copied for
# usage in your own projects. You will pass this path to
# the precompiler with the -I option.
# LOCLIBDIR Defines the path where the binary library will be
# placed.
# TF_WWWBASEDIR Defines the path to your personal homepage. That's the
# place where doxygen output will be written too (see
# below).
#
# make all installs headers, binary libraries and documentation
#
# Documentation
# -------------
# Fortran code: libfourier.doc
# C++ code: doxygen output at ${TF_WWWBASEDIR}
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# REVISIONS and CHANGES
# 07/11/2002 V1.0 Thomas Forbriger
......@@ -190,21 +157,6 @@ libfourier.a: $(LIBOBS)
# If it is not available to you, you should set TF_REMCMMNT=cat (see below)
#
# ============================================================================
#
# environment variables
# ---------------------
#
# You will like to set the following environment variables:
#
# LOCINCLUDEDIR Defines the path where header files will be copied for
# usage in your own projects. You will pass this path to
# the precompiler with the -I option.
# LOCLIBDIR Defines the path where the binary library will be
# placed.
# TF_WWWBASEDIR Defines the path to your personal homepage. That's the
# place where doxygen output will be written too (see
# below).
# files
# -----
......
......@@ -5,15 +5,41 @@ 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.
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.
Binary libraries
----------------
libfourier.a Fortran library
libfourierxx.a C++ library
Dependencies
------------
libaff is required to compile the binary libraries
fftw3 is required for the C++ library
doxygen is required to process source code documentation
Installation
------------
environment variables:
LOCINCLUDEDIR Defines the path where header files will be copied for
usage in your own projects. You will pass this path to
the precompiler with the -I option.
LOCLIBDIR Defines the path where the binary library will be
placed.
TF_WWWBASEDIR Defines the path to your personal homepage. That's the
place where doxygen output will be written too (see
below).
make all installs headers, binary libraries and documentation
Detailed documentation is provided through libfourier.doc (fortran code)
and doxygen source code. See target doxydoc in the Makefile.
----- END OF README -----
......@@ -22,22 +22,9 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
#
# Installation instructions
# -------------------------
#
# To install the library use target install
#
# To instell the library together with the doxygen documentation,
# use target all. Note that this requires doxygen to be installed.
#
# Look at gsexx_write_example.cc for a brief example on using the code.
#
# The binary library libgsexx.a will be placed in $(LOCLIBDIR). The prototype
# file gsexx.h will be linked to a copy in $(LOCINCLUDEDIR).
#
# The doxygen documentation will be placed in $(DOXYWWWPATH).
#
# The library code itself depends only on common system libraries.
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# REVISIONS and CHANGES
# 16/03/2002 V1.0 Thomas Forbriger
......
......@@ -17,6 +17,25 @@ 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.
Installation instructions
-------------------------
To install the library use target install
To instell the library together with the doxygen documentation,
use target all. Note that this requires doxygen to be installed.
Look at gsexx_write_example.cc for a brief example on using the code.
The binary library libgsexx.a will be placed in $(LOCLIBDIR). The prototype
file gsexx.h will be linked to a copy in $(LOCINCLUDEDIR).
The doxygen documentation will be placed in $(DOXYWWWPATH).
The library code itself depends only on common system libraries.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -21,6 +21,9 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# 05/01/2003 V1.1 added C++ sections
#
......@@ -110,23 +113,6 @@ rhetest: rhetest.o librheology.a
CXXDIR=cxx
#
# environment variables
# ---------------------
#
# You will like to set the following environment variables:
#
# LOCINCLUDEDIR Defines the path where header files will be copied for
# usage in your own projects. You will pass this path to
# the precompiler with the -I option.
# LOCLIBDIR Defines the path where the binary library will be
# placed.
# WWWBASEDIR Defines the path to your personal homepage. That's the
# place where doxygen output will be written too (see
# below).
#
# You will find the installed library header files in $(LOCINCLUDEDIR)/aff
# files
# -----
......
......@@ -9,4 +9,22 @@ librheology is a collection of Fortran 77 and C++ code supporting the
evaluation of frequency dependent complex visco-elastic moduli for different
rheological models.
Installation
------------
environment variables:
LOCINCLUDEDIR Defines the path where header files will be copied for
usage in your own projects. You will pass this path to
the precompiler with the -I option.
LOCLIBDIR Defines the path where the binary library will be
placed.
TF_WWWBASEDIR Defines the path to your personal homepage. That's the
place where doxygen output will be written too (see
below).
make all installs headers, binary libraries and documentation
Detailed documentation is provided through libfourier.doc (fortran code)
and doxygen source code. See target doxydoc in the Makefile.
----- END OF README -----
......@@ -25,17 +25,6 @@
# ----
#
#=============================================================================
#
# Installation
# ------------
# environment variables:
# LOCLIBDIR defines location of binary libraries
# LOCINCLUDEDIR defines location of C header files (prototypes)
#
# Fortran version: libseife.a
# C version: libcseife.a
#
# make all installs headers and binary libraries
#
# REVISIONS and CHANGES
# 25/10/2000 V1.0 Thomas Forbriger
......
......@@ -18,4 +18,16 @@ 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
------------
environment variables:
LOCLIBDIR defines location of binary libraries
LOCINCLUDEDIR defines location of C header files (prototypes)
Fortran version: libseife.a
C version: libcseife.a
make all installs headers and binary libraries
----- END OF README -----
......@@ -22,30 +22,9 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
#
# Installation instructions
# -------------------------
# The command
# make all
# will compile and install the binary executables as well as the doxygen
# documentation.
#
# Environment variables control where the results are stored and where
# libraries and library header files are expected:
# LOCLIBDIR defines location of binary libraries
# LOCINCLUDEDIR defines location of C/C++ header files (prototypes)
# LOCBINDIR defines location of binary executables
#
# Dependencies:
# Compilers required to build the programs:
# Fortran compiler (gfortran is currently supported)
#
# The library does not require any other prerequisites.
#
# Tests and examples:
# teststuff tfullread tfullwrite tservice tskipdata
#
# Source code and file format documentation:
# sff.doc, libsff.doc (both produced by 'make doc')
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# REVISIONS and CHANGES
# 23/12/2003 V1.0 Thomas Forbriger
......
......@@ -11,6 +11,32 @@ library is provided as a static binary library:
libsff.a static library to be used with gfortran
Installation instructions
-------------------------
The command make all will compile and install the binary executables as well
as the doxygen documentation.
Environment variables control where the results are stored and where
libraries and library header files are expected:
LOCLIBDIR defines location of binary libraries
LOCINCLUDEDIR defines location of C/C++ header files (prototypes)
LOCBINDIR defines location of binary executables
Dependencies:
Compilers required to build the programs:
Fortran compiler (gfortran is currently supported)
The library does not require any other prerequisites.
Tests and examples:
teststuff tfullread tfullwrite tservice tskipdata
Source code and file format documentation:
sff.doc, libsff.doc (both produced by 'make doc')
Documentation is provided in the source file (stuff.f) and can be
extracted the files:
......@@ -19,7 +45,7 @@ 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 see Makefile
......
......@@ -22,23 +22,9 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
#
#
# Installation instructions
# -------------------------
#
# To install the library use target install
#
# To instell the library together with the doxygen documentation,
# use target all. Note that this requires doxygen to be installed.
# The doxygen documentation will be placed in $(DOXYWWWPATH).
#
# Look at sfftest.cc for a brief example on using the code.
#
# The binary library libsffxx.a will be placed in $(LOCLIBDIR). The prototype
# files will be copied to $(LOCINCLUDEDIR).
#
# This library requires code from libgsexx, libaff, and libtime.
# The testprogram sfftest requires libtfxx in addition.
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# REVISIONS and CHANGES
# 18/12/2003 V1.0 Thomas Forbriger
......
......@@ -22,6 +22,23 @@ 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.
Installation instructions
-------------------------
To install the library use target install
To instell the library together with the doxygen documentation,
use target all. Note that this requires doxygen to be installed.
The doxygen documentation will be placed in $(DOXYWWWPATH).
Look at sfftest.cc for a brief example on using the code.
The binary library libsffxx.a will be placed in $(LOCLIBDIR). The prototype
files will be copied to $(LOCINCLUDEDIR).
This library requires code from libgsexx, libaff, and libtime.
The testprogram sfftest requires libtfxx in addition.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -25,42 +25,6 @@
# TF++, Miscellaneous classes and modules in C++
# ==============================================
#
# A collection of miscellaneous code frequently used by C++ programs in
# TFSoftware.
#
# Installation instructions
# -------------------------
# The command
# make all
# will compile and install the binary executables as well as the doxygen
# documentation.
#
# Environment variables control where the results are stored and where
# libraries and library header files are expected:
# LOCLIBDIR defines location of binary libraries
# LOCINCLUDEDIR defines location of C/C++ header files (prototypes)
# LOCBINDIR defines location of binary executables
# TF_WWWBASEDIR defines location of doxygen output
#
# Dependencies:
# Compilers required to build the programs:
# C++ compiler
# C/C++ preprocessor
# doxygen (required to process source code documentation)
#
# TFSoftware libraries required to compile the code:
# direct dependencies:
# libtsxx, libaff, libsffxx, libtime, libgsexx
# indirect dependencies:
# libseife, libdatrwxx
#
# Further non-standard libraries required to compile the code:
# - the C++ standard template library (STL)
# - libboost
# - libgsl
#
# Tests and examples are provided in subdirectory tests
#
# A note on header files:
# We extensively comment class declarations within the header files. The
# reduce compilation time when using the library code, comments will be
......@@ -74,7 +38,9 @@
# http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
# If it is not available to you, you should set TF_REMCMMNT=cat (see below)
#
# The source code itself depends only on common system libraries and the STL.
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# REVISIONS and CHANGES
# 15/11/2002 V1.0 Thomas Forbriger
......
......@@ -14,6 +14,40 @@ http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/libs/libtfxx
Please send bug reports and suggestions to
Thomas.Forbriger@kit.edu
Installation instructions
-------------------------
The command make all will compile and install the binary executables
as well as the doxygen documentation.
Environment variables control where the results are stored and where
libraries and library header files are expected:
LOCLIBDIR defines location of binary libraries
LOCINCLUDEDIR defines location of C/C++ header files (prototypes)
LOCBINDIR defines location of binary executables
TF_WWWBASEDIR defines location of doxygen output
Dependencies:
Compilers required to build the programs:
C++ compiler
C/C++ preprocessor
doxygen (required to process source code documentation)
TFSoftware libraries required to compile the code:
direct dependencies:
libtsxx, libaff, libsffxx, libtime, libgsexx
indirect dependencies:
libseife, libdatrwxx
Further non-standard libraries required to compile the code:
- the C++ standard template library (STL)
- libboost
- libgsl
Tests and examples are provided in subdirectory tests
The source code itself depends only on common system libraries and the STL.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -22,8 +22,9 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
#
# Other libraries that are required to compile libtsxx:
# libaff, libtfxx, libgsexx, libtime, libdatrwxx, libsffxx, libcseife
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
#
# REVISIONS and CHANGES
# 18/12/2003 V1.0 Thomas Forbriger
......
......@@ -13,6 +13,25 @@ Provided are recursive filters (i.e. an interface to seife), FIR decimating
filters, interpolation filters, tapers, containers for time series data
together with header data, and more.
Installation