...
Setting up the build environment
ecfFlow 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 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
...
- 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 apiAPI, 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 CMake will run some tests on the customer's system to find out if required third-party software libraries are available and notes note their locations (paths). Based on this information it will produces produce the Makefiles needed to compile and install ecFlow
...
After changing into the build ecflow directory, the user 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 The table below gives an overview of the different options of configure. The default (without any options) will will install in /usr/local/.
cmake options | doc | default |
|---|---|---|
| CMAKE_INSTALL_PREFIX | where you want to install your ecFlow | /usr/local |
| CMAKE_BUILD_TYPE | to select the type of compilation:
| Release |
| 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 |
| CMAKE_PREFIX_PATH | use to provide a path to dependent libraries which that are installed in a non-system locations. | |
| ENABLE_GUI | enable the build of ecflowview (requires X11 and motif) | on |
| ENABLE_ALL_TESTS | enable performance, migration, memory leak , and regression tests | off |
| ENABLE_SSL | Encrypted communication for user commands (experimental, from ecFlow release 4.5.0). Please see: Open ssl for more details. | off |
| ENABLE_SECURE_USER | password-based protection for user commands (experimental, from ecFlow release 4.5.0) Please see: Black list file (experimental) for more details. | off |
| BOOST_ROOT | 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.
...
| 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 |
...
- creating a file called servers
The format of the servers file is 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/.