foam-extend4.1-coherent-io

Archived

This repository has been archived on 2023-11-20. You can view files and clone it, but cannot push or open issues or pull requests.

History

Martin Beaudoin 6cebda5e41 testHarness: adding the environment variable CDASH_SCM_INFO in order to override the SCM information that gets appended at the end of the buildname string. The buildname string is the string that will identify your test run when published on the foam-extend CDash service. When using git, this SCM information is picked up automatically from the CTest script: -git-branch=the_git_branch_name-git-rev=the_git_revision_number. But when using a non-git SCM (mercurial, etc), when the foam-extend source code you are testing is not under a valid git repository, or simply when a user needs to add more details to the standard SCM information (branch name and revision number), then setting the environment variable CDASH_SCM_INFO to the proper information will allow you to override the suffix we add at the end of the buildname. Please note that in order to keep the CMake script simple, for non-git repositories, the fallback solution to try grabbing the information through Mercurial has been removed. Please use the CDASH_SCM_INFO environment varible instead.		2015-08-15 14:23:15 -04:00
..
CMakeFiles	testHarness: adding the environment variable CDASH_SCM_INFO in order to override	2015-08-15 14:23:15 -04:00
runDir	testHarness: adjusting some messages for foam-extend	2015-08-06 12:16:44 +01:00
scripts	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-17 23:07:46 -04:00
README.txt	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-17 23:07:46 -04:00

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