testHarness/OSIG/Turbomachinery/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
  27 #              the TurboMachinery OSIG
  28 #
  29 # Author:
  30 #              Martin Beaudoin, Hydro-Quebec, 2010. All rights reserved.
  31 # \*---------------------------------------------------------------------------*/
  32
  33
  34 Warning #1: Make sure your OpenFOAM environment is properly initialized before
  35             running the test harness.
  36
  37 Warning #2: Make sure to create an environment variable called $BREEDER_15_DIR
  38             This environment variable must point to the Breeder_1.5 directory
  39             of your local working copy of the openfoam-extend Subversion repository
  40
  41             Something like: export BREEDER_15_DIR=/someAbsolutePath/Breeder_1.5
  42
  43 Warning #3: It is recommended to use cmake version 2.8.0 or newer for
  44             running the test harness.
  45
  46
  47
  48 1: Instructions for starting a local test harness on your machine:
  49 ------------------------------------------------------------------
  50
  51 a) You can set your local system identifier using the environment variable
  52    $CDASH_SUBMIT_LOCAL_HOST_ID.  Please try using a unique identifier like
  53    your machine's hostname. Otherwise, the fully qualified name of your system
  54    will be used.
  55
  56
  57 b) Install the CMakeLists.txt and CTestConfig.cmake files by executing the following commands:
  58
  59 cp ./CMakeFiles/CMakeLists.txt $BREEDER_15_DIR/OSIG/TurboMachinery/CMakeLists.txt
  60 cp ./CMakeFiles/CTestConfig.cmake.openfoam-extend $BREEDER_15_DIR/OSIG/TurboMachinery/CTestConfig.cmake
  61
  62
  63 c) Run the test harness and push your results on the CDash server on openfoam-extend
  64
  65 cd ./runDir; ./Allrun_Experimental
  66   or
  67 cd ./runDir; ./Allrun_Nightly
  68
  69
  70 2: Instructions for restarting your setup from scratch:
  71 -------------------------------------------------------
  72 cd ./runDir; ./Allclean
  73
  74
  75 3: About submitting your results
  76 --------------------------------
  77
  78 Both Allrun_Experimental and Allrun_Nightly scripts will submit their results
  79 to the CDash server of your choice, as specified by the file
  80 $BREEDER_15_DIR/OSIG/TurboMachinery/CTestConfig.cmake
  81
  82 To submit your results to the CDash server on openfoam-extend, just use
  83 the file CTestConfig.cmake.openfoam-extend.
  84
  85 If submitted to the CDash server on openfoam-extend, your results will be displayed here:
  86 http://openfoam-extend.sourceforge.net/CDash/index.php?project=Turbomachinery-1.5-dev
  87