moved doxygen source to doxygen.txt , added COPYING and worked on README

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: 5338
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c

src/ts/wf/COPYING

+this is <COPYING>
+============================================================================
+ts/wf: time series waveform filters
+-------------------------------
+$Id$
+============================================================================
+
+Copyright (C) 1996, 2011 by Thomas Forbriger 
+
+----
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version. 
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+----
+
+----- END OF COPYING ----- 

src/ts/wf/Makefile

@@ -6,6 +6,23 @@
 # 
 # time series waveform filters
 #
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
+#
 # Makefile fuer tools /src/ts/wf
 #
 # 22/01/2001      introduced smoos and did some "tidy up"
@@ -75,13 +92,16 @@ clean: ;
 
 TESTCASEMAKE=$(filter-out %.bak,$(wildcard testcases/Makefile*))
 
-EDITFILES=Makefile README $(wildcard *.cfg) COPYING
+# the frame of doxygen documentation is palced in text files
+DOXYTXT=$(shell find . -name doxygen\*.txt)  
+
+EDITFILES=Makefile README $(wildcard *.cfg) COPYING $(DOXYTXT)
 EDITSRC=$(wildcard *.cc *.h *.c *.f *.txt *.gpt *.inc)
 EDITTESTS=$(wildcard testcases/*.par) $(wildcard testcases/*.tpl) \
     $(TESTCASEMAKE) $(wildcard testcases/*.gpt)
 
 flist: $(wildcard *.txt *.c *.f *.h *.inc Makefile *.cc *.gpt) \
-  doxydoc.cfg README \
+  doxydoc.cfg README COPYING $(DOXYTXT)\
   $(wildcard testcases/*.par) $(wildcard testcases/*.tpl) \
   $(TESTCASEMAKE) $(wildcard testcases/*.gpt) $(TF_EDIT)
 	echo $(filter $(EDITFILES),$^) | tr ' ' '\n' | sort > $@
@@ -223,7 +243,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/tswf
 
 doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH)
 
-DOXYSRC=README $(wildcard *.h *.cc *.f)
+DOXYSRC=$(DOXYTXT) $(wildcard *.h *.cc *.f)
 
 # create doxygen intermediate configuration
 PWD=$(shell env pwd)

src/ts/wf/README

-/*! \file ts/wf/README
- * \brief Waveform filter programs
- *
- * ----------------------------------------------------------------------------
- *
- * $Id$
- * 
- * Copyright (c) 2010 by Thomas Forbriger
- * 
- * A collection of waveform filter programs
- *
- * This file contains:
- *  - documentation of namespace datrw
- *  - mainpage text
- * 
- * REVISIONS and CHANGES 
- *  - 12/12/2010   V1.0   Thomas Forbriger
- * 
- * ============================================================================
- */
+this is <README>
+============================================================================
+ts/wf: time series waveform filters
+-------------------------------
+$Id$
+============================================================================
+============================================================================
 
-/*! \mainpage
- * 
- * \author Thomas Forbriger
- * \since December 2010
- * \date December 2010
- * \version V1.0
- * $Id$
- * 
- * These pages collect distributed documentation from the collection of waveform
- * filter programs.
- * \li autocorr.cc
- * \li convolve.cc
- * \li coro.f
- * \li cross.cc
- * \li deconv.cc
- * \li dise.f
- * \li evelo.f
- * \li foutra.cc: PSD analysis, Fourier amplitude spectrum, Amplitude of
- *     harmonic components
- * \li fredofi.cc
- * \li gatherdiff.cc
- * \li hamres.f
- * \li noisymize.cc
- * \li phasedsignals.f
- * \li resaseda.cc
- * \li rotate.f
- * \li sigfit.cc
- * \li siggen.f
- * \li sigval.cc
- * \li smoos.f
- * \li soutifu.cc
- * \li stufi.f
- * \li susei.f
- * \li suspect.f
- * \li teseco.cc
- * \li tesiff.f
- * \li teswf.f
- * \li tidofi.cc
- * \li tisli.f
- * \li tsfilt.f
- * \li xyz2uvw.f
- */
+Installation
+------------
 
-// ----- END OF README ----- 
+For compilation instructions see README.1st in the root directory of the
+tar-ball or
+http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/installation 
+
+
+The Makefile supports program compilation and linking. Some binary libraries
+are required. 
+
+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)
+
+  extern libraries/packages needed to compile the code
+    PGPLOT
+    liblapack:      linear algebra package
+    libblas:        basic linear algebra functions
+
+  
+  TFSoftware libraries required to compile the code:
+    libaff
+    libtime
+    libseife
+    libfourier
+    liblinearxx
+    libgsexx
+    libdatrwxx
+    libsffxx
+    libtsxx
+    libtfxx
+
+============================================================================
+
+The home of this software suite is
+http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/ts/wf
+
+Please send bug reports and suggestions to
+Thomas.Forbriger@kit.edu
+
+----- END OF README ----- 

src/ts/wf/doxydoc.cfg

@@ -91,7 +91,7 @@ INPUT                  =
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.cc *.f \
                          *.h \
-                         README
+                         doxygen*.txt
 RECURSIVE              = NO
 EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO

src/ts/wf/doxygen.txt

+/*! \file ts/wf/doxygen.txt
+ * \brief Waveform filter programs
+ *
+ * ----------------------------------------------------------------------------
+ *
+ * $Id$
+ * 
+ * Copyright (c) 2010 by Thomas Forbriger
+ * 
+ * A collection of waveform filter programs
+ *
+ * This file contains:
+ *  - documentation of namespace datrw
+ *  - mainpage text
+ * 
+ * REVISIONS and CHANGES 
+ *  - 12/12/2010   V1.0   Thomas Forbriger
+ *  - 11/11/2013   V1.1   renamed file (tmetz)
+ * ============================================================================
+ */
+
+/*! \mainpage
+ * 
+ * \author Thomas Forbriger
+ * \since December 2010
+ * \date December 2010
+ * \version V1.0
+ * $Id$
+ * 
+ * These pages collect distributed documentation from the collection of waveform
+ * filter programs.
+ * \li autocorr.cc
+ * \li convolve.cc
+ * \li coro.f
+ * \li cross.cc
+ * \li deconv.cc
+ * \li dise.f
+ * \li evelo.f
+ * \li foutra.cc: PSD analysis, Fourier amplitude spectrum, Amplitude of
+ *     harmonic components
+ * \li fredofi.cc
+ * \li gatherdiff.cc
+ * \li hamres.f
+ * \li noisymize.cc
+ * \li phasedsignals.f
+ * \li resaseda.cc
+ * \li rotate.f
+ * \li sigfit.cc
+ * \li siggen.f
+ * \li sigval.cc
+ * \li smoos.f
+ * \li soutifu.cc
+ * \li stufi.f
+ * \li susei.f
+ * \li suspect.f
+ * \li teseco.cc
+ * \li tesiff.f
+ * \li teswf.f
+ * \li tidofi.cc
+ * \li tisli.f
+ * \li tsfilt.f
+ * \li xyz2uvw.f
+ */
+
+// ----- END OF doxygen.txt ----- 

src/ts/wf/testcases/Makefile

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # test cases for waveform filters
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    09/06/2011   V1.0   Thomas Forbriger

src/ts/wf/testcases/Makefile.deconv

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # test deconv
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    24/06/2011   V1.0   Thomas Forbriger

src/ts/wf/testcases/Makefile.filters

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # test filter programs
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    24/06/2011   V1.0   Thomas Forbriger

src/ts/wf/testcases/Makefile.foutra

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # test foutra
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    24/06/2011   V1.0   Thomas Forbriger

src/ts/wf/testcases/Makefile.phasedsignals

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # test phasedsignals.f
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    24/06/2011   V1.0   Thomas Forbriger

src/ts/wf/testcases/Makefile.resaseda

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # test resampling algorithm
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    24/06/2011   V1.0   Thomas Forbriger

src/ts/wf/testcases/Makefile.soutifu

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # testcases for soutifu
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    24/06/2011   V1.0   Thomas Forbriger

src/ts/wf/testcases/Makefile.teseco

@@ -5,6 +5,23 @@
 # Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 # 
 # test teseco
+#
+# ----
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version. 
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# ----
+#
 # 
 # REVISIONS and CHANGES 
 #    24/06/2011   V1.0   Thomas Forbriger