ecFlow's documentation is now on readthedocs!

Please go to https://ecflow.readthedocs.io/en/latest/index.html

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 61 Next »

Dependencies

  • Python 2.7  ( Python 3.0 not tested )

    If you intend to use ecFlow Python API, You will need to install Python.

    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.

  • Xlib, X11, XMotif for ecflowview .

    Do not use Lesstif library to compile ecflowview as a replacement for Motif. 

    OpenMotif can be downloaded from http://www.ist.co.uk/downloads/motif_download.html
    If you do not want use the GUI, then you can configure the build to ignore this dependency.

Setting up the build environment

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

    • boost_1_53_0.tar.gz

    •  ecFlow-4.0.8-Source.tar.gz

      Create a directory for the build:

      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:

    gunzip boost_1_53_0.tar.gz
gunzip ecFlow-4.0.8-Source.tar.gz
tar -xf boost_1_53_0.tar
tar -xf ecFlow-4.0.8-Source.tar

  • You should have two directories created:

    boost_1_53_0
ecFlow-4.0.8-Source

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

     

    export WK=/tmp/ecflow_build/ecFlow-4.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:

     

    cd $BOOST_ROOT
./bootstrap.sh

     

    Now make sure bjam is accessible from $PATH

  • Ecflow uses some of compiled libraries in boost. The following script will build the required lib’s, in both debug and release forms and will configure boost build according to your platform.

     

    cd $BOOST_ROOT
$WK/build/boost_1_53_fix.sh    # fix for boost, only for some platforms
$WK/build/boost_build.sh       # compile boost libs used by ecFlow

Build

There are two build systems available for ecflow:

  • boost-build/bjam 
  • cmake

It is recommended to try cmake/ecbuild first.

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 notes their locations (paths). Based on this information it will produces the Makefiles needed to compile and install Magics.

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

cmake/ecbuild
cd $WK
mkdir build; cd build;

# Specify the directory where you want ecflow installed, we have used '/usr/local/apps/ecflow' as an example
cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/apps/ecflow -DCMAKE_BUILD_TYPE=Release

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

# If you do not need the python api, use:
# cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/apps/ecflow -DCMAKE_BUILD_TYPE=Release -DENABLE_PYTHON=OFF

make
make install

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

 

 

export PYTHONPATH=$PYTHONPATH:/usr/local/apps/ecflow/4.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:

    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:

     

    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.

     

    bjam variant=release -j4
  • Once ecFlow is built it can be installed:

     

    bjam variant=release install-all

     

    This will create directories:

    <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 . 

     

    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)

 

  • No labels