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