Skip to content

Installing_RAVEN_Libraries

Paul Talbot edited this page Jul 17, 2018 · 10 revisions

Installing Libraries Needed to Run RAVEN

RAVEN requires various python libraries to run.

Standard Installation

RAVEN uses conda to maintain a contained library environment with all the specific tested python library versions needed to run RAVEN. If conda is not present on a system, it can usually be installed locally with no issue. The requirements may change from commit to commit, but can be updated via a simple utility.

To install or update Python libraries, navigate to the folder where raven is located and do the following:

cd raven
scripts/establish_conda_env.sh --install

This will install the correct set of libraries for your copy of RAVEN.

Conda Options

For facilitating a variety of computing environments, there are additional options for installing the Python libraries.

Defining location of conda

RAVEN will assume conda is in the default install location, which is operating system-dependent, unless it is told another directory to use. If conda is not installed in the default location, the establish_conda_env.sh script needs to be told where "conda.sh" is using the argument "--conda-defs":

scripts/establish_conda_env.sh --install --conda-defs ~/myconda/etc/profile.d/conda.sh

where myconda might be replaced with any path to the conda installation location. This location will be stored to the file raven/.ravenrc and referred to whenever RAVEN is run.

Changing RAVEN libraries name

By default, RAVEN installs the required Python libraries into a conda environment named "raven_libraries". In the event another name is desired, a bash global environment variable "RAVEN_LIBS_NAME" can be defined to override this default. For example, to rename the environment to "myRavenLibs":

export RAVEN_LIBS_NAME=myRavenLibs
scripts/establish_conda_env.sh

This name will be stored to the file raven/.ravenrc and referred to each time RAVEN runs.

Alternate Installation

In the event conda cannot be used, some suggestions for operating systems are listed below. To get the full list of libraries RAVEN needs to install, along with their specific versions, run the commands:

cd raven
python scripts/TestHarness/testers/RavenUtils.py --conda-install --linux

replacing "--linux" with "windows" or "macosx" depending on your operating system, which will print to terminal the list of libraries that should be installed for RAVEN to run, along with specific tagged versions. These libraries will need to be installed through a package manager such as conda or pip, or via the operating system tools listed below. Note the library lists in the examples below are not exhaustive, but give an example of how the libraries can be installed.

OSX

As described in http://mooseframework.org/getting-started/osx/ First install XQuartz and XCode command line tools.

OSX conda

The MOOSE redistributable package installs conda, and conda can be used to install the libraries:

sudo bash
#Set up http_proxy and https_proxy variables if needed
conda install -y numpy hdf5 h5py scipy scikit-learn matplotlib swig

OSX Mavericks 10.9

The MOOSE redistributable package (From http://mooseframework.org/getting-started/osx/ ) contains everything needed to run RAVEN. Alternatively install the raven libraries package raven_miniconda.dmg

OSX Yosemite 10.10

Either install the moose package (From http://mooseframework.org/getting-started/osx/ ) , or install the raven libraries package raven_miniconda.dmg, or use the raven_libs_script.sh

Linux

Either use apt-get or yum to install libraries, or use raven_libs_script.sh

Fedora (22 or newer):

Library install:

dnf install swig libtool gcc-c++ python-devel python3-devel \
 numpy h5py scipy python-scikit-learn python-matplotlib-qt4

Tex install (to rebuild manual):

dnf install texlive texlive-subfigure texlive-stmaryrd \
  texlive-titlesec texlive-preprint texlive-placeins

Ubuntu (14.4 or newer):

Library install:

sudo apt-get install libtool python-dev swig g++ python3-dev \
 python-numpy python-sklearn python-h5py

Tex install (to rebuild manual):

sudo apt-get install texlive-latex-base texlive-extra-utils \
  texlive-latex-extra texlive-math-extra

Installing without root privilages

For this, the raven_libs_script.sh should be used.