Skip to content

INSTALL.md

Latest commit

 

History

History
158 lines (141 loc) · 6.77 KB

INSTALL.md

File metadata and controls

158 lines (141 loc) · 6.77 KB

Installation instructions for MC++/CRONOS/CANON/MAGNUS (last updated 2025-09-26)

Windows: install WSL2 with default distribution (Ubuntu 24.04 LTS)

  • from Powershell or Command Prompt run wsl --install, then follow the instructions to set up a user account (a system restart might be required)
  • all subsequent commands are to be run from the Ubuntu terminal (use it via Windows Terminal)
  • sudo apt update && sudo apt full-upgrade
  • explorer.exe . lets you browse Ubuntu directories using the Windows file explorer

Required compilers and build tools

  • sudo apt install build-essential gfortran cmake

Set up Git

  • git config --global user.name "<NAME>"
  • git config --global user.email "<EMAIL>"
  • change the default text editor: git config --global core.editor <EDITOR>

SSH key

  • generate a new keypair: ssh-keygen -t ed25519, then press Enter a few times to continue with the default options
  • read the public key with cat ~/.ssh/id_ed25519.pub, copy and add it to the Github account settings

MC++ dependencies

  • sudo apt install liblapack-dev libblas-dev
  • Boost: sudo apt install libboost-all-dev, then verify that the boost libraries have been installed correctly with cat /usr/include/boost/version.hpp | grep "BOOST_LIB_VERSION"
  • obtain the HSL libraries MC13, MC21, MC33; then tar -xzf mc13-1.0.0.tar.gz, cd mc13-1.0.0, ./configure and sudo make install (repeat for MC21 and MC33)
  • Armadillo dependencies: sudo apt install libopenblas-dev libarpack2-dev libsuperlu-dev
  • Armadillo: download the latest release (currently v15.0.3), extract it with tar -xJf armadillo-15.0.3.tar.xz, cd armadillo-15.0.3 then ./configure and sudo make install

MC++

  • cd /opt
  • clone the repository git clone git@github.com:omega-icl/mcpp.git
  • cd mcpp/src
  • git submodule init && git submodule update
  • sudo make install

Environment variables

  • append the following lines to ~/.bashrc using a text editor
export PYTHONPATH="${PYTHONPATH}:/opt/mcpp/src/pymc"
  • restart the terminal for changes to take effect, or run source ~/.bashrc

CRONOS dependencies

  • SuiteSparse: sudo apt install libsuitesparse-dev

SUNDIALS

  • download the latest release (currently v7.4.0), then extract it with tar -xzf sundials-7.4.0.tar.gz
  • create a build directory with mkdir sundials-build
  • cd sundials-build
  • cmake -DCMAKE_INSTALL_PREFIX=/opt/sundials-7.4.0 \
      -DEXAMPLES_ENABLE_CXX=ON \
      -DEXAMPLES_INSTALL_PATH=/opt/sundials-7.4.0/examples \
      -DENABLE_LAPACK=ON \
      -DENABLE_PTHREAD=ON \
      -DENABLE_KLU=ON \
      -DKLU_INCLUDE_DIR=/usr/include/suitesparse \
      -DKLU_LIBRARY_DIR=/lib/x86_64-linux-gnu \
      ../sundials-7.4.0
  • sudo make install

Alternative: CVODES only, no examples

  • download the latest release (currently v7.4.0), extract it with tar -xzf cvodes-7.4.0.tar.gz
  • create a build directory with mkdir cvodes-build
  • cd cvodes-build
  • cmake -DCMAKE_INSTALL_PREFIX=/opt/sundials-7.4.0 \
      -DENABLE_LAPACK=ON \
      -DENABLE_PTHREAD=ON \
      -DENABLE_KLU=ON \
      -DKLU_INCLUDE_DIR=/usr/include/suitesparse \
      -DKLU_LIBRARY_DIR=/lib/x86_64-linux-gnu \
      ../cvodes-7.4.0
  • sudo make install

Environment variables

  • append the following lines to ~/.bashrc using a text editor
export SUNDIALS_HOME="/opt/sundials-7.4.0"
export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:/usr/lib/x86_64-linux-gnu:${SUNDIALS_HOME}/lib"
export PYTHONPATH="${PYTHONPATH}:/opt/cronos/src/interface"
  • restart the terminal for changes to take effect, or run source ~/.bashrc

CRONOS

  • cd /opt
  • clone the repository: git clone git@github.com:omega-icl/cronos.git
  • cd cronos/src
  • sudo make install

CANON dependencies: SNOPT

  • obtain SNOPT7
  • sudo apt install unzip
  • unzip the file with unzip snopt7.7.zip, cd snopt7, ./configure --prefix=/opt/snopt77 --with-c --with-cpp and finally sudo make install

CANON dependencies: GAMS

  • download the latest GAMS installer (currently v51.1.0)
  • sudo mkdir /opt/gams && cd /opt/gams
  • move the installer into this directory sudo mv <FILEPATH> /opt/gams/ (<FILEPATH> can be a Windows path, for example /mnt/c/Users/<username>/Downloads/linux_x64_64_sfx.exe)
  • make sure the file can be executed with sudo chmod u+x linux_x64_64_sfx.exe and run it sudo ./linux_x64_64_sfx.exe

CANON dependencies: Gurobi

  • get the latest Gurobi Optimizer installer (currently v12.0.3)
  • move the installer sudo mv <FILEPATH> /opt
  • sudo tar -xzf gurobi12.0.3_linux64.tar.gz

Fix for Gurobi under WSL2

  • append the following lines to ~/.bashrc to assign a fixed MAC address, otherwise the license does not work after WSL2 restarts
# assign a persistent MAC address for adapter bond0 and rename it eth1
mac=1a:2b:3c:4d:5e:6f
if ! ip link show | grep -q $mac; then
  sudo ip link add bond0 type bond  # only if no bond0 adapter present already
  sudo ip link set dev bond0 down
  sudo ip link set dev bond0 address $mac
  sudo ip link set dev bond0 name eth1
  sudo ip link set dev eth1 up
fi

Gurobi license

  • generate a Named-User Academic license on the website, run grbgetkey <LICENSE_KEY> and click enter to save it at the default location
  • add the following line to ~/.bashrc and restart the terminal
export GRB_LICENSE_FILE="${HOME}/gurobi.lic"

Environment variables

  • append the following lines to ~/.bashrc
export GAMS_HOME="/opt/gams/gams51.1_linux_x64_64_sfx"
export GUROBI_HOME="/opt/gurobi1203/linux64"
export SNOPT_HOME="/opt/snopt77"
export PATH="${PATH}:${GUROBI_HOME}/bin"
export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:${GUROBI_HOME}/lib:${SNOPT_HOME}/lib"
export PYTHONPATH="${PYTHONPATH}:/opt/canon/src/interface"
  • restart the terminal for changes to take effect, or run source ~/.bashrc

CANON

  • cd /opt
  • clone the repository: git clone git@github.com:omega-icl/canon.git
  • cd canon/src
  • sudo make install

Environment variables

  • append the following lines to ~/.bashrc
export PYTHONPATH="${PYTHONPATH}:/opt/magnus/src/interface"
  • restart the terminal for changes to take effect, or run source ~/.bashrc

MAGNUS

  • cd /opt
  • clone the repository: git clone git@github.com:omega-icl/magnus.git
  • cd magnus/src
  • sudo make install