testHarness/README.txt

   1 Description
   2 ===========
   3 This part of the repository is for OpenFOAM test harnesses.
   4
   5
   6 Directory Structure
   7 ===================
   8
   9 OpenFOAM            : CMake/CTest scripts for compilation and execution test harness for OpenFOAM.
  10 OpenFOAM/1.6-dev    : Test harness for OpenFOAM version 1.6-dev. See the file OpenFOAM/1.6-dev/README.txt for more information
  11
  12 OSIG                : CMake/CTest scripts for OpenFOAM 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 OpenFOAM environment is properly configured to run OpenFOAM.
  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 OpenFOAM test harness
  37
  38    cd $WM_PROJECT_DIR/testHarness/OpenFOAM/1.6-ext/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_of-1.6-ext-testing $WM_PROJECT_DIR/CTestConfig.cmake
  46
  47
  48 7:   Next, running the test loop is pretty simple:
  49
  50    cd $WM_PROJECT_DIR/testHarness/OpenFOAM/1.6-ext/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=OpenFOAM-1.6-ext_testing
  59    Username : of-1.6-ext@of-extend.cdash
  60    Password : onepasswd4all
  61
  62
  63 9: You can customize your system identifier on the dashboard using the environment variable $CDASH_SUBMIT_LOCAL_HOST_ID.
  64    Otherwise, the fully qualified name of your system will be used.
  65
  66    A good customization idea would be to add the name of your git branch in your system ID.
  67    I will probably modify my scripts to add this information automagically.
  68
  69    NB: Please no "forward slash" or "/" in the system ID; it looks like CDash will choke on this.
  70
  71
  72 10: In general, see the file $WM_PROJECT_DIR/testHarness/OpenFOAM/1.6-ext/README.txt for the necessary information about running the
  73     test loop.
  74     (NB: I just found out a couple of mistakes in that file, so please use this message for now as per instructions for running the test loop.
  75          I will fix this shortly. Sorry.)
  76
  77
  78 11: As more people will start using these basic steps, I will supply more information about some other features that are available with
  79     the test loop.
  80
  81     But I need to see those baby steps first...  :)
  82
  83
  84 12: Please do not hesitate to report any problems, comments, suggestions about the test loop.
  85     This stuff runs great on my systems, but it needs to run even better on yours.