testHarness/README.txt

   1 Description
   2 ===========
   3 This part of the repository is for FOAM test harnesses.
   4
   5
   6 Directory Structure
   7 ===================
   8
   9 FOAM            : CMake/CTest scripts for compilation and execution test harness for FOAM.
  10 foam-extend-3.0    : Test harness for foam-extend version 3.0. See the file foam-extend-3.0/README.txt for more information
  11
  12 OSIG                : CMake/CTest scripts for FOAM Special Interest Group (OSIG) test harness
  13 OSIG/TurboMachinery : Test harness for the TurboMachinery OSIG. See the file OSIG/Turbomachinery/README.txt for more information.
  14
  15
  16 Martin Beaudoin, Hydro-Quebec, 2010. All rights reserved.
  17
  18
  19 1: Select your git branch of choice: ie:
  20
  21    git checkout master   # For Hrv master branch
  22
  23
  24 2: Make sure your FOAM environment is properly configured to run FOAM.
  25
  26
  27 3: The minimal cmake version number for running the test loop is 2.8.0. Make sure you are there.
  28
  29
  30 4: Make sure you have the test harness scripts available under your git branch;
  31    otherwise, you will need to fetch this from Hrv's master branch, and merge it into yours
  32
  33    ls $WM_PROJECT_DIR/testHarness  # Checking availability of testHarness under this branch
  34
  35
  36 5: move to the runDir directory for the FOAM test harness
  37
  38    cd $WM_PROJECT_DIR/testHarness/foam-extend/3.0/runDir
  39
  40
  41 6: Normally, if using the master branch, everything should already be setup for you to run the test harness.
  42    Still, I recommand always checking that these two important files are up-to-date:
  43
  44    cp ../CMakeFiles/CMakeLists.txt $WM_PROJECT_DIR
  45    cp ../CMakeFiles/CTestConfig.cmake.openfoam-extend $WM_PROJECT_DIR/CTestConfig.cmake
  46
  47
  48 7:   Next, running the test loop is pretty simple:
  49
  50    cd $WM_PROJECT_DIR/testHarness/foam-extend-3.0/runDir # you should already be there...
  51    ./Allclean
  52    ./Allrun_Experimental
  53
  54
  55 8: The results will be published on the CDash dashboard on openfoam-extend.
  56
  57    To see your results:
  58    URL      : http://openfoam-extend.sourceforge.net/CDash/index.php?project=foam-extend-3.0
  59
  60
  61 9: You can customize your system identifier on the dashboard using the environment variable $CDASH_SUBMIT_LOCAL_HOST_ID.
  62    Otherwise, the fully qualified name of your system will be used.
  63
  64    A good customization idea would be to add the name of your git branch in your system ID.
  65    I will probably modify my scripts to add this information automagically.
  66
  67    NB: Please no "forward slash" or "/" in the system ID; it looks like CDash will choke on this.
  68
  69
  70 10: In general, see the file $WM_PROJECT_DIR/testHarness/foam-extend/3.0/README.txt for the necessary information about running the
  71     test loop.
  72
  73
  74 11: Please do not hesitate to report any problems, comments, suggestions about the test loop.