Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/devel' into trivial
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-cogliati-inl committed Apr 30, 2024
2 parents 6105e93 + b56970b commit 6085ce4
Show file tree
Hide file tree
Showing 133 changed files with 6,032 additions and 9,783 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@
[submodule "plugins/FARM"]
path = plugins/FARM
url = https://github.com/Argonne-National-Laboratory/FARM.git
[submodule "plugins/BayCal"]
path = plugins/BayCal
url = https://github.com/idaholab/BayCal.git
24 changes: 12 additions & 12 deletions dependencies.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@ Structure:
Note all install methods after "main" take
Instructions:
add library: <library>pinned.version.number</library>
add with no pinned version: <library/>
remove a library: <library>remove</library>
action for limited OS: <library os='windows'>...
action for certain machine <library machine='arm64'>...
add library from forge: <library source='forge'>...
optional: <library optional='True'>...
skip run/install check: <library skip_check='True'>...
add library: <library>pinned.version.number</library>
add with no pinned version: <library/>
remove a library: <library>remove</library>
action for limited OS: <library os='windows'>...
action for certain machine <library machine='arm64'>...
add library from forge: <library source='forge'>...
add library from git repository: <library source='pip' repo='https://addressOfRepository/libraryName.git'>...
optional: <library optional='True'>...
skip run/install check: <library skip_check='True'>...
add pip library with extra parameters:
<ray source="pip" pip_extra="[tune]">1.9</ray>
<ray source="pip" pip_extra="[tune]">1.9</ray>
the above will use pip_extra to translate into a command:
pip install ray[tune]==1.9.*
which installs ray and the dependencies for Ray Tune
Expand Down Expand Up @@ -59,10 +60,10 @@ Note all install methods after "main" take
<lxml/>
<psutil/>
<pip/>
<pyDOE3/>
<importlib_metadata/>
<pyside2 optional='True'/>
<nomkl os='linux' skip_check='True'/>
<numexpr os='linux'/>
<cmake skip_check='True' optional='True'/>
<dask source="pip" pip_extra="[complete]"/>
<ray source="pip" pip_extra="[default]">2.6</ray>
Expand All @@ -89,14 +90,14 @@ Note all install methods after "main" take
<liblapack skip_check='True' os='mac' machine='x86_64'>3.9.0=20_osx64_openblas</liblapack>
<!-- source="mamba" are the ones installed when mamba is installed -->
<mamba source="mamba" skip_check='True'/>
<serpentTools optional='True' source="pip"/>
</main>
<alternate name="pip">
<hdf5>remove</hdf5>
<swig>remove</swig>
<pip>remove</pip>
<python>remove</python>
<nomkl>remove</nomkl>
<numexpr>remove</numexpr>
<liblapack>remove</liblapack>
</alternate>
<alternate name="none">
Expand All @@ -105,6 +106,5 @@ Note all install methods after "main" take
<pip>remove</pip>
<python>remove</python>
<nomkl>remove</nomkl>
<numexpr>remove</numexpr>
</alternate>
</dependencies>
5 changes: 5 additions & 0 deletions developer_tools/check_pip_packages.sh
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,15 @@ conda activate python39_pip
python -m pip uninstall -y raven_framework || echo not installed
python -m pip install dist/raven_framework*cp39*.whl || exit -1

# Run some tests to check that the installed package is working. The user_guide
# tests are all pretty simple, and there are only a few of them, so we'll use those.
$RAVEN_DIR/run_tests --re="user_guide" --tester-command RavenFramework raven_framework --skip-load-env

echo
echo Checking Python 3.10

conda activate python310_pip
python -m pip uninstall -y raven_framework || echo not installed
python -m pip install dist/raven_framework*cp310*.whl || exit -1

$RAVEN_DIR/run_tests --re="user_guide" --tester-command RavenFramework raven_framework --skip-load-env
31 changes: 30 additions & 1 deletion doc/user_manual/code_interfaces/relap5.tex
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ \subsubsection{Models}
\end{lstlisting}

An additional feature of the RELAP5 Code interface is the possibility to specify operation based on the value of user-inputted
cards. For example, let's assume the values in cards 1180801:2 and 1180802:2 must come from a calculation based on sampled variables (e.g. 20100154:2 and 20100155:2), the user can specify the following XML node:
cards. For example, let's assume the values in cards 1180801:2 and 1180802:2 must come from a calculation based on
sampled variables (e.g. 20100154:2 and 20100155:2), the user can specify the following XML node:

\begin{itemize}
\item \xmlNode{operator}, \xmlDesc{XML node, optional parameter}, The operator block.
Expand Down Expand Up @@ -148,6 +149,34 @@ \subsubsection{Models}
</Models>
\end{lstlisting}

The RELAP interface also allows for specifying the datatype of the cards' values. Indeed there are cards and
words in relap that requires, for example, the values to be integers. By default (if the following card is not inputted)
the code will treat all the values as floats.
In order to input the datatypes, the user can specify the following XML node:

\begin{itemize}
\item \xmlNode{datatypes}, \xmlDesc{XML node, optional parameter}, The datatypes block.
This XML node can optionally contain the following attribute:
\begin{itemize}
\item \textit{integers}, \xmlDesc{comma separated list, optional parameter}, The list of cards that must
be cast as integers (e.g. 1180802:2,1180803:2)
\end{itemize}
\end{itemize}

An example is reported below:
\begin{lstlisting}[style=XML]
<Models>
<Code name='MyRELAP' subType='Relap5'>
<executable>~/path_to_the_executable</executable>
...
<datatypes>
<integers>1180802:2,1180803:2</integers>
</datatypes>
...
</Code>
</Models>
\end{lstlisting}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Distributions}
Expand Down
Loading

0 comments on commit 6085ce4

Please sign in to comment.