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

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

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. 

cd $WK
mkdir build; cd build;

# Go with defaults, thiswill should build with CMAKE_BUILD_TYPE=Release and install to /usr/local
cmake .. 

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

# Override install prefix, build the most optimised executables 
# cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/apps/ecflow -DCMAKE_BUILD_TYPE=Release  /4.14.0 

# do notNOT build the 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 need thebuild python api, use:
# cmake .. -DCMAKE_CXX_FLAGS="-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:<prefix>/4.1217.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.1217.0/lib/python2.7/site-packages/ecflow 

cd $WK/build  # change to the build directory
cmake -DCMAKE_INSTALL_PREFIX=/tmp/avi/custom/ecflow/4.1217.0 -DCOMPONENT=python -P cmake_install.cmake -- make install  # install python module under /tmp/avi/custom/ecflow/4.1117.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.

...

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