Page History

...

• cmake (   install cmake   (sudo apt-get install cmake)).   Need at least cmake/3.13.4
• g++     (   install g++        (sudo apt-get install g++))   ecflow 5 series can only be built with C++14 or later  compilers. i.e. at the minimum gcc 6.3 or clang 6.0.
• Python 3(optional)
  

  If you intend to use ecFlow Python API, You will need to install Python. (install python-dev (sudo apt-get install python-dev))

  Please ensure that python is accessible on $PATH otherwise, you may need to customise $BOOST_ROOT/tools/build/v2/site-config.jam . 

  The python installation should include the development packages

  If you do not need the python API, then you can build without it, see below.
• Qt for ecFlowUI (Qt5 mandatory).
  For self-installed Qt libraries, consider setting CMAKE_PREFIX_PATH (see below). See also http://doc.qt.io/qt-5/cmake-manual.html for further details.
• OpenSSL(optional)
• sphinx(optional), this is used to generate ecflow python API

Setting up the build environment

• ecFlow consists of two tar files i.e.:  
  

  • boost_1_71_0.tar.gz (or any recent boost)

  • ecFlow-5.58.31-Source.tar.gz

    Create a directory for the build:

    Code Block
    language bash
    mkdir /tmp/ecflow_build

    
    

• Copy the two tar file into this directory, then change directory to /tmp/ecflow_build

• Un-zip then un-tar the two file files:

  Code Block
  language bash
  tar -zxf boost_1_71_0.tar.gz tar -zxf ecFlow-5.58.31-Source.tar.gz

  
  

• You should have two directories created:

  Code Block
  boost_1_71_0 ecFlow-5.58.31-Source

  
  

• Create two environment variables. These are used by some of the scripts:

  Code Block
  export WK=/tmp/ecflow_build/ecFlow-5.58.31-Source export BOOST_ROOT=/tmp/ecflow_build/boost_1_71_0

  
  

• If you have a module system, please ensure that before you start, GCC,cmake,python3, etc are available in $PATH.

  Code Block
  language bash
  module load gnu module load cmake module load python3 module load qt

  
  

...

cd $WK
mkdir build; cd build;

# Go with defaults, will build with CMAKE_BUILD_TYPE=Release and install to /usr/local
cmake .. 
# Override install prefix 
# cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/apps/ecflow/5.58.31 

# do NOT build the gui.
# cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/apps/ecflow -DCMAKE_BUILD_TYPE=Release -DENABLE_UI=OFF

# ignore Wdeprecated-declarations compiler warning messages and do NOT build python api
# cmake .. -DCMAKE_CXX_FLAGS="-Wno-deprecated-declarations"  -DENABLE_PYTHON=OFF

# Use -j option to speed up compilation. Determine number of cpu's
CPUS=$(lscpu -p | grep -v '#' | wc -l)
make -j${CPUS}
make check
make install

...

cd $WK
rm -rf build
mkdir build; cd build
cmake ..      # or use whatever cmake configuration you used before

To use the ecFlow Python Api, you need to add/change PYTHONPATH. 

...

export PYTHONPATH=$PYTHONPATH:<prefix>/5.58.31/lib/python3.6/site-packages/ecflow
# If you used the default's then <prefix>=/usr/local
# otherwise you should use whatever you entered for -DCMAKE_INSTALL_PREFIX, hence in the examples above we would have:
export PYTHONPATH=$PYTHONPATH:/usr/local/apps/ecflow/5.58.31/lib/python3.6/site-packages/ecflow 

...

cd $WK/build  # change to the build directory
cmake -DCMAKE_INSTALL_PREFIX=/tmp/avi/custom/ecflow/5.58.31 -DCOMPONENT=python -P cmake_install.cmake -- make install  # install python module under /tmp/avi/custom/ecflow/5.58.31

ecflow_ui: Make a list servers accessible to all users

...

• creating a file called servers

• The format of the server's file is very easy:

  Code Block
  title server file format
  <server_name> <machine_name> <port>

  An example might be:

  Code Block
  title servers file
  server machineX 3141 projectX machineabc 4141 exp1 machineabc 4141 mars bigmac 11031

  
  

• Copy this file to CMAKE_INSTALL_PREFIX/share/ecflow/.   This makes the list of servers accessible to all users of ecflow_ui

  Code Block
  cp servers /tmp/avi/custom/ecflow/5.58.31/share/ecflow/.

  
  

Python API (from ecflow 5.6.0)

The most up to date python API documentation can be generated. This requires that sphinx-build is available on $PATH.

cd $WK
cd Doc/online
make clean; make html

The api can then be viewed in the browser. Please open file $WK/Doc/online/_build/html/index.html