Dependencies

Setting up the build environment

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

  • boost_1_53_0.tar.gz

  •  ecFlow-4.17.0.8-Source.tar.gz

    Create a directory for the build:

    Code Block
    language bash
    mkdir /tmp/ecflow_build

    
    

• Copy the 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
  gunzip boost_1_53_0.tar.gz gunzip ecFlow-4.0.8-Source.tar.gz tar -xf-zxf boost_1_53_0.tar.gz tar -xfzxf ecFlow-4.17.0.8-Source.tar.gz

  
  

• You should have two directories created:

  Code Block
  boost_1_53_0 ecFlow-4.17.0.8-Source

  
  

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

 

• Code Block

language	bash

• export WK=/tmp/ecflow_build/ecFlow-4.17.0

.8

• -Source export BOOST_ROOT=/tmp/ecflow_build/boost_1_53_0

  
  

Build boost

• Boost uses bjam for building the boost libs.

  bjam source is available in boost, hence we first need to build bjam itself:

   

  
  

  Code Block
  language bash
  cd $BOOST_ROOT ./bootstrap.sh

  
  

• For python3

  Code Block
  ./bootstrap.sh --with-python=/path/to/python3

  You may need to update $BOOST_ROOT/project-config.jam, with path to executable and path to include files. 

  Code Block
  # using python # : # version # : # cmd-or-prefix # : # includes # : # libraries # : # condition # ; using python : 3.6 : /usr/local/apps/python3/3.6.8-01/bin/python3 : /usr/local/apps/python3/3.6.8-01/include/python3.6m ; # remember to preserve the spaces, as they are significant

  
  

• IF you do not require the ecFlow python API, you can avoid building boost python libs by setting.

 export ECF_NO_PYTHON=1

...

Now make sure bjam is accessible from $PATH

...

...

...

...

Build

cmake

As configure, CMake will run some tests on the customer's system to find out if required third-party software libraries are available and note their locations (paths). Based on this information it will produce the Makefiles needed to compile and install ecFlow

CMake is a cross-platform free software program for managing the build process of software using a compiler-independent method.

Generating the Makefiles with CMake

After changing into the build ecflow directory, the user has to run CMake with his/her own options. The command gives feedback on what requirements are fulfilled and what software is still required. The table below gives an overview of the different options of configure.  The default (without any options) will install in /usr/local/.

The  C++  compilers are chosen by CMake. (This can be overwritten by setting the environment variables CXX on the command line before you call cmake, to the preferred compiler).

Further, the variable CMAKE_CXX_FLAGS can be used to set compiler flags for optimisation or debugging. 

Build

There are two build systems available for ecflow:

• boost-build/bjam 
• cmake

It is recommended to try cmake/ecbuild first.

cmake

cd $WK
mkdir build; cd build;

# SpecifyGo thewith directorydefaults, wherewill youbuild want ecflow installed, we have used '/usr/local/apps/ecflow' as an example
with CMAKE_BUILD_TYPE=Release and install to /usr/local
cmake .. 

# build release with debug info  
# cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo

# Override install prefix 
# cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/apps/ecflow -DCMAKE_BUILD_TYPE=Release/4.14.0 

# If you do not wantNOT build the GUI, use:gui.
# cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/apps/ecflow -DCMAKE_BUILD_TYPE=Release -DENABLE_GUI=OFF

# If youignore Wdeprecated-declarations compiler warning messages and do notNOT needbuild the python api, use:
# cmake .. -DCMAKE_INSTALLCXX_PREFIX=/usr/local/apps/ecflow -DCMAKE_BUILD_TYPE=ReleaseFLAGS="-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:/usr/local/apps/ecflow<prefix>/4.17.0.8/lib/python2.7/site-packages/ecflow

boost-build/bjam

• For installation the following environment variables are required.

            ECFLOW_INSTALL_DIR         # Directory Location for client ,server and gui program's
  ECFLOW_PYTHON_INSTALL_DIR  # Directory Location for ecflow python package
          

  The python installation can be customised, by changing Pyext/jamfile.jam and $BOOST_ROOT/tools/build/v2/site-config.jam

• We now need to build ecFlow. Currently ecflowview is only built if environment variable of name ARCH is set to linux:

  Code Block
  language bash
  cd $WK bjam variant=release

   

  On some systems like fedora/redhat you may run into compiler errors

  which complain about the template depth being exceeded.

  In this case compile using:

   

  Code Block
  language bash
  cd $WK bjam c++-template-depth=512 variant=release

   

  If you have a multi-core machine, you can speed up the build using:

  the -j<n> option. Where ‘n’ is an integer, of the number of cores.

   

  Code Block
  language applescript
  bjam variant=release -j4

• Once ecFlow is built it can be installed:

   

  Code Block
  language bash
  bjam variant=release install-all

   

  This will create directories:

  Code Block
  <ECFLOW_INSTALL_DIR>/bin <ECFLOW_INSTALL_DIR>/lib <ECFLOW_INSTALL_DIR>/doc <ECFLOW_INSTALL_DIR>/share <ECFLOW_PYTHON_INSTALL_DIR>

  Depending on your umask setting you may need to call chmod 755 on the executables

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

   

  Code Block
  language bash
  export PYTHONPATH=$PYTHONPATH:$ECFLOW_PYTHON_INSTALL_DIR

• When compiling ecflowview in a system where motif is not installed in the usual location, or where both motif and lesstif are installed, it is possible to export the environment variables MOTIF_INCLUDE and MOTIF_LIBRARY to help bjam to find the right location for include files and libraries.

  Openmotif may be retrieve from IST server and installed locally: wget http://www.ist-inc.com/motif/download/motif_files/openmotif-2.1.32-2_IST.x86_64.rpm rpm2cpio openmotif-2.1.32-2_IST.x86_64.rpm | cpio -idmv

  user shall then compile setting MOTIF_INCLUDE and MOTIF_LIBRARY variable.

• By default the ecflowview 'server' and‘ecflowview.menu’ files are placed in  <ECFLOW_INSTALL_DIR>/share/ecflow directory. However you can use ECFLOWVIEW_HOME shell variable to override this.
• ECFLOWRC variable may be set to use alternative directory for user ecflowview option files (default is $HOME/.ecflowrc)

# 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/4.17.0/lib/python2.7/site-packages/ecflow 

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

ecflow_ui: Make a list servers accessible to all users

The GUI used by ecFlow is called ecflow_ui.  This is used to interact and visualize the ecFlow servers.

You can make the list of servers available for your users by:

• 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/4.17.0/share/ecflow/.

...