foam-extend4.1-coherent-io/testHarness/foam-extend/4.0/README.txt

# /*-------------------------------------------------------------------------*\
#   =========                 |
#   \\      /  F ield         | foam-extend: Open Source CFD
#    \\    /   O peration     |
#     \\  /    A nd           | For copyright notice see file Copyright
#      \\/     M anipulation  |
# -----------------------------------------------------------------------------
# License
#     This file is part of foam-extend.
#
#     foam-extend 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 3 of the License, or (at your
#     option) any later version.
#
#     foam-extend 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 foam-extend.  If not, see <http://www.gnu.org/licenses/>.
#
# Description:
      README file for the CMake/CTest/CDash test harness for FOAM.
#
# Author:
#     Martin Beaudoin, Hydro-Quebec, 2010. All rights reserved.
#
# \*-------------------------------------------------------------------------*/

Warning #1: Make sure your FOAM environment is properly initialized before
            running the test harness.

Warning #2: It is recommended to use cmake version 2.8.0 or newer for
            running the test harness.


1: Instructions for starting a local test harness on your machine:
------------------------------------------------------------------

a) You can set your local system identifier using the environment variable
   $CDASH_SUBMIT_LOCAL_HOST_ID.  Please try using a unique identifier like
   your machine's hostname. Otherwise, the fully qualified name of your system
   will be used.


b) Install the CMakeLists.txt and CTestConfig.cmake files by executing the following commands:

cp ./CMakeFiles/CMakeLists.txt $WM_PROJECT_DIR
cp ./CMakeFiles/CTestConfig.cmake.foam-extend $WM_PROJECT_DIR/CTestConfig.cmake


c) Run the test harness and push your results on the CDash server on foam-extend

cd ./runDir; ./Allclean; ./Allrun_Experimental
  or
cd ./runDir; ./Allclean; ./Allrun_Nightly


2: Instructions for restarting your setup from scratch:
-------------------------------------------------------
cd ./runDir; ./Allclean


3: About submitting your results
--------------------------------

Both Allrun_Experimental and Allrun_Nightly scripts will submit their results
to the CDash server of your choice, as specified by the file
$WM_PROJECT_DIR/CTestConfig.cmake.

To submit your results to the CDash server on foam-extend, just use
the file CTestConfig.cmake.foam-extend.

If submitted to the CDash server on foam-extend, your results will be displayed here:
http://foam-extend.sourceforge.net/CDash/index.php?project=foam-extend-3.2
Initial update of test harness. 2013-12-16 14:35:43 +00:00			`# /-------------------------------------------------------------------------\`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`# ========= \|`
Renamed and cleaned foam-extend 2013-12-11 16:09:41 +00:00			`# \\ / F ield \| foam-extend: Open Source CFD`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`# \\ / O peration \|`
Renamed and cleaned foam-extend 2013-12-11 16:09:41 +00:00			`# \\ / A nd \| For copyright notice see file Copyright`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`# \\/ M anipulation \|`
Initial update of test harness. 2013-12-16 14:35:43 +00:00			`# -----------------------------------------------------------------------------`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`# License`
Renamed and cleaned foam-extend 2013-12-11 16:09:41 +00:00			`# This file is part of foam-extend.`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`#`
Renamed and cleaned foam-extend 2013-12-11 16:09:41 +00:00			`# foam-extend is free software: you can redistribute it and/or modify it`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`# under the terms of the GNU General Public License as published by the`
Renamed and cleaned foam-extend 2013-12-11 16:09:41 +00:00			`# Free Software Foundation, either version 3 of the License, or (at your`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`# option) any later version.`
			`#`
Renamed and cleaned foam-extend 2013-12-11 16:09:41 +00:00			`# foam-extend 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.`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`#`
			`# You should have received a copy of the GNU General Public License`
Renamed and cleaned foam-extend 2013-12-11 16:09:41 +00:00			`# along with foam-extend. If not, see <http://www.gnu.org/licenses/>.`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`#`
			`# Description:`
Initial update of test harness. 2013-12-16 14:35:43 +00:00			`README file for the CMake/CTest/CDash test harness for FOAM.`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`#`
			`# Author:`
Initial update of test harness. 2013-12-16 14:35:43 +00:00			`# Martin Beaudoin, Hydro-Quebec, 2010. All rights reserved.`
			`#`
			`# \-------------------------------------------------------------------------/`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00
Initial update of test harness. 2013-12-16 14:35:43 +00:00			`Warning #1: Make sure your FOAM environment is properly initialized before`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`running the test harness.`

			`Warning #2: It is recommended to use cmake version 2.8.0 or newer for`
			`running the test harness.`


			`1: Instructions for starting a local test harness on your machine:`
			`------------------------------------------------------------------`

			`a) You can set your local system identifier using the environment variable`
			`$CDASH_SUBMIT_LOCAL_HOST_ID. Please try using a unique identifier like`
Remove trailing whitespace systematically 2013-07-18 01:02:34 +00:00			`your machine's hostname. Otherwise, the fully qualified name of your system`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`will be used.`


			`b) Install the CMakeLists.txt and CTestConfig.cmake files by executing the following commands:`

			`cp ./CMakeFiles/CMakeLists.txt $WM_PROJECT_DIR`
testHarness: various adjustments for foam-extend 3.2. The results will now be reported on the foam-extend project CDash service on SourceForge.net 2015-06-18 03:00:45 +00:00			`cp ./CMakeFiles/CTestConfig.cmake.foam-extend $WM_PROJECT_DIR/CTestConfig.cmake`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00

testHarness: various adjustments for foam-extend 3.2. The results will now be reported on the foam-extend project CDash service on SourceForge.net 2015-06-18 03:00:45 +00:00			`c) Run the test harness and push your results on the CDash server on foam-extend`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00
Test loop: updated info in README file 2010-10-13 17:22:57 +00:00			`cd ./runDir; ./Allclean; ./Allrun_Experimental`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00			`or`
Test loop: updated info in README file 2010-10-13 17:22:57 +00:00			`cd ./runDir; ./Allclean; ./Allrun_Nightly`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00

			`2: Instructions for restarting your setup from scratch:`
			`-------------------------------------------------------`
			`cd ./runDir; ./Allclean`


			`3: About submitting your results`
			`--------------------------------`

			`Both Allrun_Experimental and Allrun_Nightly scripts will submit their results`
			`to the CDash server of your choice, as specified by the file`
Remove trailing whitespace systematically 2013-07-18 01:02:34 +00:00			`$WM_PROJECT_DIR/CTestConfig.cmake.`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00
testHarness: various adjustments for foam-extend 3.2. The results will now be reported on the foam-extend project CDash service on SourceForge.net 2015-06-18 03:00:45 +00:00			`To submit your results to the CDash server on foam-extend, just use`
			`the file CTestConfig.cmake.foam-extend.`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00
testHarness: various adjustments for foam-extend 3.2. The results will now be reported on the foam-extend project CDash service on SourceForge.net 2015-06-18 03:00:45 +00:00			`If submitted to the CDash server on foam-extend, your results will be displayed here:`
			`http://foam-extend.sourceforge.net/CDash/index.php?project=foam-extend-3.2`
Add test loop scripts under the directory testHarness. Add the necessary CMake files 2010-10-07 03:00:07 +00:00