Skip to content

installationLinux

Congjian Wang - INL edited this page May 19, 2023 · 30 revisions

Installation of RAVEN libraries

The process for installing RAVEN Python libraries is detailed at the link below. This works on any system that can build conda; more details on alternatives are also found there.

Install RAVEN Libraries

Installation of other RAVEN dependencies

In addition, RAVEN requires git and g++:

  • apt-get (Ubuntu) or dnf (Fedora)
sudo apt-get install libtool git python3-dev swig g++ virtualenv
dnf install swig libtool gcc-c++ redhat-rpm-config python3-devel git conda

Optionally, if you want to be able to edit and rebuild the manual, you can install TEX Live and its related packages:

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

or

dnf install texlive-scheme-full 

Clone RAVEN

Open a terminal window and cd into the folder where you want to install RAVEN (e.g., projects)

[~]> mkdir projects
[~]> cd projects
[~/projects]> git clone https://github.com/idaholab/raven.git
[~/projects]> cd raven

Install RAVEN Plugins (ONLY IF YOU HAVE ACCESS TO PLUGINS)

This step is optional, and you need to contact the raven developers to obtain the access first if you need non-open source plugins. Contact us. The installation instruction can be found: RAVEN Plugins.

Install RAVEN libraries

cd raven
./scripts/establish_conda_env.sh --install

The establish_conda_env.sh process is maintained to provide the best libraries for each commit of RAVEN. In the event libraries cannot be installed through conda, see Installing RAVEN Libraries.

Experimental Features:

  • Use Mamba to install RAVEN which can accelerate the installation process: ./scripts/establish_conda_env.sh --mamba

  • Use “pip” to install RAVEN (https://pypi.org/project/raven-framework/) pip install raven-framework These should work on Linux, Mac OS and Windows. After installation, the raven_framework command can be used to run raven.

Compiling RAVEN

[~/projects/raven]> ./build_raven 

In case the RAVEN libraries have been installed without the conda installation package, In the event libraries have not been installed through conda (see Installing RAVEN Libraries ), RAVEN needs to be built with the following option:

[~/projects/raven]> ./build_raven --skip-conda

Test RAVEN installation

[~/projects/raven]> ./run_tests -j2

A large number of tests are run in order to check that the installation step has been successful. At the end, a screen output is generated similar to the one below, although the number of tests will not be the same:

383 passed, 19 skipped, 0 pending, 0 failed

Update RAVEN

[~/projects]> cd raven
[~/projects/raven]> git pull
[~/projects/raven]> scripts/establish_conda_env.sh --install
[~/projects/raven]> ./build_raven
[~/projects/raven]> ./run_tests -j2
Clone this wiki locally