- 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
ecfFlow consists of two tar files i.e.:
Create a directory for the 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:
You should have two directories created:
Create two environment variables. These are used by some of the scripts:
If you have a module system, please ensure that before you start, gcc,cmake,python2,python3,etc are available in $PATH.
- Boost uses bjam for building the boost libs.bjam source is available in boost, hence we first need to build bjam itself:
You may need to update $BOOST_ROOT/project-config.jam, with path to executable and path to include files.
- IF you do not require the ecFlow python api, you can avoid building boost python libs by setting.
before calling $WK/build_scripts/boost_build.sh (see below)
ecFlow uses some of compiled libraries in boost. The following script will build the required lib’s and configure boost build according to your platform
If you want to build python2 and python3. Then ALWAYS build the python3 first. See earlier steps
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 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. Table below gives an overview of the different options of configure. The default (without any options) will install in /usr/local/.
|CMAKE_INSTALL_PREFIX||where you want to install your ecFlow||/usr/local|
to select the type of compilation:
|CMAKE_CXX_FLAGS||more flags for the C++ compiler|
|ENABLE_SERVER||build the ecFlow server||on|
|ENABLE_PYTHON||enable python interface||on|
|PYTHON_EXECUTABLE||Pyhon3. Path to python3 executable. ONLY required if cmake version is less than 3.12.0|
|ENABLE_UI||enable build of ecflowUI (requires Qt)||on|
use to provide path to dependent libraries which are installed in a non-system locations.
|ENABLE_GUI||enable build of ecflowview (requires X11 and motif)||on|
enable performance, migration, memory leak , and regression tests
Encrypted communication for user commands (experimental, from ecFlow release 4.5.0).
Please see: Open ssl for more details.
password based protection for user commands (experimental, from ecFlow release 4.5.0)
Please see: Black list file (experimental) for more details.
where to find boost ( if non-standard installation )
If not specified cmake will look for an environment variable of the same name.
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.
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 .
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:
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 servers file is very easy:
An example might be:
Copy this file to CMAKE_INSTALL_PREFIX/share/ecflow/. This makes the list of servers accessible to all users of ecflow_ui