testHarness/OpenFOAM/1.6-ext/README.txt

   1 # /*---------------------------------------------------------------------------*\
   2 #   =========                 |
   3 #   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4 #    \\    /   O peration     |
   5 #     \\  /    A nd           | Copyright held by original author
   6 #      \\/     M anipulation  |
   7 # -------------------------------------------------------------------------------
   8 # License
   9 #     This file is part of OpenFOAM.
  10 #
  11 #     OpenFOAM is free software; you can redistribute it and/or modify it
  12 #     under the terms of the GNU General Public License as published by the
  13 #     Free Software Foundation; either version 2 of the License, or (at your
  14 #     option) any later version.
  15 #
  16 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19 #     for more details.
  20 #
  21 #     You should have received a copy of the GNU General Public License
  22 #     along with OpenFOAM; if not, write to the Free Software Foundation,
  23 #     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24 #
  25 # Description:
  26 #              README file for the CMake/CTest/CDash test harness for OpenFOAM.
  27 #
  28 # Author:
  29 #              Martin Beaudoin, Hydro-Quebec, 2010. All rights reserved.
  30 # \*---------------------------------------------------------------------------*/
  31
  32 Warning #1: Make sure your OpenFOAM environment is properly initialized before
  33             running the test harness.
  34
  35 Warning #2: It is recommended to use cmake version 2.8.0 or newer for
  36             running the test harness.
  37
  38
  39 1: Instructions for starting a local test harness on your machine:
  40 ------------------------------------------------------------------
  41
  42 a) You can set your local system identifier using the environment variable
  43    $CDASH_SUBMIT_LOCAL_HOST_ID.  Please try using a unique identifier like
  44    your machine's hostname. Otherwise, the fully qualified name of your system
  45    will be used.
  46
  47
  48 b) Install the CMakeLists.txt and CTestConfig.cmake files by executing the following commands:
  49
  50 cp ./CMakeFiles/CMakeLists.txt $WM_PROJECT_DIR
  51 cp ./CMakeFiles/CTestConfig.cmake.openfoam-extend $WM_PROJECT_DIR/CTestConfig.cmake
  52
  53
  54 c) Run the test harness and push your results on the CDash server on openfoam-extend
  55
  56 cd ./runDir; ./Allclean; ./Allrun_Experimental
  57   or
  58 cd ./runDir; ./Allclean; ./Allrun_Nightly
  59
  60
  61 2: Instructions for restarting your setup from scratch:
  62 -------------------------------------------------------
  63 cd ./runDir; ./Allclean
  64
  65
  66 3: About submitting your results
  67 --------------------------------
  68
  69 Both Allrun_Experimental and Allrun_Nightly scripts will submit their results
  70 to the CDash server of your choice, as specified by the file
  71 $WM_PROJECT_DIR/CTestConfig.cmake.
  72
  73 To submit your results to the CDash server on openfoam-extend, just use
  74 the file CTestConfig.cmake.openfoam-extend.
  75
  76 If submitted to the CDash server on openfoam-extend, your results will be displayed here:
  77 http://openfoam-extend.sourceforge.net/CDash/index.php?project=OpenFOAM-1.6-ext
  78