| Warning |
|---|
ecflow 4 v4 is no longer actively developed, only critical issues will be fixed. Please migrate to ecflow 5 at your earliest convenience |
Dependencies
- cmake ( install cmake (sudo apt-get install cmake))
- g++ ( install g++ (sudo apt-get install g++))
- Python 2.7 or Python 3
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 .
If you do not need the python api, then you can build without it, see below.The python installation should include the development packages
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.- Qt for ecFlowUI (Qt5 preferred).
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.
Setting up the build environment
ecFlow consists of two tar files i.e.:
boost_1_53_0.tar.gz
- ecFlow-4.17.0-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_53_0.tar.gz tar -zxf ecFlow-4.17.0-Source.tar.gz
You should have two directories created:
Code Block boost_1_53_0 ecFlow-4.17.0-Source
Create two environment variables. These are used by some of the scripts:
Code Block export WK=/tmp/ecflow_build/ecFlow-4.17.0-Source export BOOST_ROOT=/tmp/ecflow_build/boost_1_53_0
If you have a module system, please ensure that before you start, gcc,cmake,python2,python3,etc are available in $PATH.
Code Block language bash module load gnu module load cmake module load python3 module load qt
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.
...
ecFlow uses some of the compiled libraries in boost. The following script will build the required lib’s and configure boost build according to your platform
Code Block language bash title Build boost libraries including python3 used by ecflow. cd $BOOST_ROOT $WK/build_scripts/boost_1_53_fix.sh # fix for boost, only for some platforms $WK/build_scripts/boost_build.sh # compile boost libs used by ecFlow. Please see notes in boost_build.sh, if you want to build both for python2 and python3
If you want to build python2 and python3. Then ALWAYS build the python3 first. See earlier steps
Code Block title Building boost python2 libs module load python mv $BOOST_ROOT/project-config.jam $BOOST_ROOT/project-config.jam_python3 # move the python3 config to the side ./bootstrap.sh # || ./bootstrap.sh --with-python=/path/to/python2 to regenerate project-config.jam ./b2 --with-python --clean # Clean previous python3 build *VERY* important $WK/build_scripts/boost_build.sh # Build boost python2 libs
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/.
...
| Warning | |||||||
|---|---|---|---|---|---|---|---|
If you experience problem with your installation, and need to fix your install of dependent libraries like QT,Python,Boost,gcc etc, then it is VERY important that you delete the build directory and start cmake build again. (This is because cmake keeps a cache of your configuration, and re-uses this unless the build directory is deleted).
|
To use the ecFlow Python Api , you need to add/change PYTHONPATH .
| Code Block | ||
|---|---|---|
| ||
export PYTHONPATH=$PYTHONPATH:<prefix>/4.17.0/lib/python2.7/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/4.17.0/lib/python2.7/site-packages/ecflow |
Installing ecFlow Python to a custom directory
The default install for ecFlow will install python(if it was enabled) under the directory given to CMAKE_INSTALL_PREFIX.
However, sometimes we may need to install the ecFlow python module to a different prefix. (starting with release 4.3.0)
This can be done using:
| Code Block |
|---|
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.
...