Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Explain how to get individual plugins in install documentation. #2135

Merged
merged 1 commit into from
Jun 26, 2023
Merged

Explain how to get individual plugins in install documentation. #2135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion doc/user_manual/Installation/clone.tex
View file
Open in desktop
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