Skip to content

Commit

Permalink
Explain how to get individual plugins in install documentation. (#2135)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-cogliati-inl authored Jun 26, 2023
1 parent afc3ecd commit 4897f99
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion doc/user_manual/Installation/clone.tex
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,23 @@ \subsubsection{Obtaining RAVEN Source Code}
\begin{lstlisting}[language=bash]
git clone https://github.com/idaholab/raven.git
cd raven
\end{lstlisting}

\subsubsection{Getting Plugins}

Individual plugins can be gotten with a command like (from the
\texttt{raven} directory):

\begin{lstlisting}[language=bash]
git submodule update --init plugins/TEAL/
python scripts/install_plugins.py -s plugins/TEAL
\end{lstlisting}

All the plugins can be gotten, but this may throw errors if there are non-open source ones currently:

\begin{lstlisting}[language=bash]
git submodule update --init
python scripts/install_plugins.py -a
\end{lstlisting}
This will obtain RAVEN as well as other submodules that RAVEN uses. In the future, whenever we declare a path
starting with \texttt{raven/}, we refer to the cloned directory.
Expand All @@ -50,7 +66,7 @@ \subsubsection{Installing Python Libraries}
cd scripts
bash.exe establish_conda_env.sh --install
\end{lstlisting}

\end{itemize}
Assure that there are no errors in this process, then continue to compiling RAVEN.

Expand Down

0 comments on commit 4897f99

Please sign in to comment.