Skip to content

installationMain

Joshua J. Cogliati edited this page Jul 17, 2024 · 6 revisions

The streamlined installation process for Microsoft Windows, Apple OSX, and Ubuntu are included and maintained in the RAVEN user manual. This documentation is intended to mirror the user manual, and offer some additional alternatives and troubleshooting.

Note on how to clone RAVEN

There are 2 ways to clone RAVEN:

  • HTTPS procedure
  • SSH procedure

The HTTP cloning procedure uses the following clone command:

 git clone https://github.com/idaholab/raven.git

The SSH version requires an addition step. The user needs to create an SSH key (See: https://help.github.com/articles/connecting-to-github-with-ssh/). Once the SSH key has been created, to clone RAVEN the following command should be executed:

 git clone [email protected]:idaholab/raven.git

Problems?

Try common solutions to problems found on our Troubleshooting page.

Note that INL users with SSL problems should see: https://servicenow.inl.gov/ess?id=kb_article_view&sys_kb_id=382baf5593de8a10c36eb7986cba1080

Compile docs

In order to compile the RAVEN docs perform the following:

[~/projects/raven]> cd doc  
[~/projects/raven/doc]> ./make_docs.sh 

PIP install

RAVEN can be installed with PIP in Python 3.9 and 3.10.

To create a Python 3.10 environment with conda use:

conda create -n raven_libraries python=3.10
conda activate raven_libraries

To install with PIP:

pip install raven-framework