File	Date	Author	Commit
runDir	2022-05-29	Martin Beaudoin	[0c133e] Add the test harness files for the Timisoara Sw...
scriptsBash	2022-05-24	Martin Beaudoin	[d70e38] Correction to make sure the additional shell ma...
scriptsCMake	2022-07-11	Martin Beaudoin	[7c4bb7] Adjusting the way to grab the hostname in order...
.gitignore	2022-05-10	Martin Beaudoin	[17afe9] Add the test harness files for the TurboWG ERCO...
CMakeLists.txt	2022-05-19	Martin Beaudoin	[5300d2] Add a dependency on the TurboTools package (lib...
COPYING	2022-05-05	Martin Beaudoin	[3a3a1f] Initial commit
CTestConfig.cmake	2022-05-08	Martin Beaudoin	[997a4f] - Adjust the minimum CMake version to 3.14 so w...
README.txt	2022-05-05	Martin Beaudoin	[3a3a1f] Initial commit

Read Me

# --------------------------------------------------------------------------
# License
#     This file is part of the TurboWG project.
#
#     The software from the TurboWG project 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.
#
#     The software from the TurboWG project 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 software.  If not, see <http://www.gnu.org/licenses/>.
#
#     For copyright notice see the file COPYING
#
# Description
#     README file for the CMake/CTest/CDash test harness for TurboWG project
#
# Author
#     Martin Beaudoin, 05/2022. All rights reserved
#
# --------------------------------------------------------------------------

Warning #1: Make sure your foam-extend/OpenFOAM environment is properly
            initialized before running the test harness.

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


1: Instructions for executing a test harness run on your machine:
-----------------------------------------------------------------

a) You can override 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 by default.

b) The test harness 'AllrunXXX' scripts located under the runDir directory will
   push your test harness results to a CDash service hosted on the cdash.org
   site.
   For browsing the TurboWG test harness results, visit the following site using
   your browser:  https://my.cdash.org/index.php?project=TurboWG

   For example, for running the Tutorials test harness, which will update the
   compilation of your FOAM installation and run all the available tutorials
   for 10 time steps:

   cd ./runDir
   ./Allclean
   ./AllrunTutorials_Experimental

  or

  cd ./runDir
  ./Allclean
  ./AllrunTutorials_Nightly


2: Instructions for resetting the test harness
----------------------------------------------
  cd ./runDir
  ./Allclean


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

By default, all the 'AllrunXXX' test harness scripts located under the runDir
directory will submit their results to the CDash service located at my.cdash.org.

It is however possible to override this location by using the following files
for your own CTestConfig.cmake file:

$FOAM_SITE_DIR/etc/CTestConfig.site.cmake
or
$WM_PROJECT_USER_DIR/etc/CTestConfig.user.cmake