2. Installation

2.1. Manual installation from the Github repo

Manual installation requires cmake, numpy, scipy, MEEP (optional), and TiledArray (optional).

You can download the latest OpenMS (or the development branch) from GitHub:

$ git clone https://github.com/lanl/OpenMS
$ cd openms
$ git checkout develop # optional if you'd like to try out the development branch

Build the libs and other extensions in openms/lib:

$ cd openms/lib
$ bash build.sh

Alternatively:

$ cd openms/lib
$ cd build
$ cmake -DCMAKEflags ../
$ make

This will automatically download required libs and compile them. Finally, to make Python find the openms package, add the top-level openms directory (not the openms/openms subdirectory) to PYTHONPATH. For example:

export PYTHONPATH=/path/to/openms:$PYTHONPATH

To ensure the installation is successful, start a Python shell, and type:

>>> import openms

2.1.1. cmake configurations

The CMAKEflags should be replaced with your proper cmake options, such as -DCMAKE_PREFIX_PATH, List of available options:

  • ENABLE_MPI – Set to ON to turn on MPI support [Default OFF]

  • ENABLE_MEEP – Set to ON to install MEEP FDTD solver for Maxwell’s equations [Default OFF]

  • ENABLE_TA – Set to ON to install TiledArray for tensor contraction[Default OFF]

  • ENABLE_TACUDA – Set to ON to turn on Cuda GPU support in TA lib [Default OFF]

  • toolchainpath – Set toolchain path to for compiling TA [Default cmake/vg/toolchains/]

  • CMAKE_BUILD_TYPE – Set build type [Default Release]

  • BUILD_INFDTD – Set ON to build internal FDTD solver [Default ON]

more details TBA