update sqa

doc/make_docs.sh

@@ -26,6 +26,7 @@
 #COMPLETENESS, OR USEFULNESS OR ANY INFORMATION, APPARATUS, PRODUCT, OR
 #PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY
 #OWNED RIGHTS.
+
 SCRIPT_NAME=`readlink $0`
 if test -x "$SCRIPT_NAME";
 then
@@ -48,6 +49,22 @@ done
 
 rm -Rvf pdfs
 
+# add custom, collective inputs to TEXINPUTS
+#
+# Since on Windows we use MikTeX (which is a native Windows program), the TEXTINPUTS variable used i
+#   to tell the LaTeX processor where to look for .sty files must be set using Windows-style paths
+#   (not the Unix-style ones used on other platforms).  This also means semi-colons need to be used
+#   to separate terms instead of the Unix colon.
+#
+if [ "$(uname)" == "Darwin" ] || [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]
+then
+  export TEXINPUTS=.:$SCRIPT_DIR/tex_inputs/:$TEXINPUTS
+elif [ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]  || [  "$(expr substr $(uname -s) 1 4)" == "MSYS" ]
+then
+  export TEXINPUTS=.\;`cygpath -w $SCRIPT_DIR/tex_inputs`\;$TEXINPUTS
+fi
+
+
 if git describe
 then
     git describe | sed 's/_/\\_/g' > new_version.tex
@@ -90,12 +107,12 @@ for DIR in  user_manual; do
     cd $SCRIPT_DIR
 done
 
-#cd sqa
-#./make_docs.sh
-#cd ..
+cd sqa
+./make_docs.sh
+cd ..
 mkdir pdfs
-for DOC in user_manual/hybrid_user_manual.pdf; do
-    cp $DOC pdfs/
+for DOC in user_manual/hybrid_user_manual.pdf sqa/sqa_built_documents/; do
+    cp $DOC* pdfs/
 done
 
 

doc/sqa/srs/requirements_list.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0" ?>
+<requirements_specification application="Hybrid">
+
+    <requirement_group id="Minimum Requirements">
+
+      <requirement_set caption="Minimum Requirements">
+          <requirement id_code="R-M-1">
+              <description>Dymola 2020x or higher</description>
+              <source>K. Frick, A. Alfonsi, C. Rabiti, ``HYBRID User Manual'', INL/MIS-20-60624</source>
+          </requirement>
+          <requirement id_code="R-M-2">
+              <description>Visual Studio 2017 or higher with associated 64-bit Intel Compiler</description>
+              <source>K. Frick, A. Alfonsi, C. Rabiti, ``HYBRID User Manual'', INL/MIS-20-60624</source>
+          </requirement>
+          <requirement id_code="R-M-3">
+              <description>Python 3 or higher to be able to execute RAVEN-based workflows</description>
+              <source>K. Frick, A. Alfonsi, C. Rabiti, ``HYBRID User Manual'', INL/MIS-20-60624</source>
+          </requirement>
+       </requirement_set>
+
+    </requirement_group>
+
+
+    <requirement_group id="Functional Requirements">
+      <requirement_set caption="Modeling">
+          <requirement id_code="R-F-1">
+              <description>HYBRID shall allow the user the leverage and use compoment models developed in Modelica language</description>
+          </requirement>
+          <requirement id_code="R-F-2">
+              <description>HYBRID shall provide models to simulate component/system control in Modelica language</description>
+          </requirement>
+      </requirement_set>
+
+      <requirement_set caption="Framework, I/O, Execution Control">
+          <requirement id_code="R-F-3">
+              <description>HYBRID shall allow the user the ability to interact with modelica models via the Dymola GUI.</description>
+              <source>https://github.com/idaholab/hybrid/wiki</source>
+          </requirement>
+      </requirement_set>
+
+    </requirement_group>
+
+    <requirement_group id="Regression Requirements">
+      <requirement_set caption="Infrastructure Support">
+          <requirement id_code="R-IS-1">
+              <description>HYBRID shall have regression tests to perform checks on modelica models.</description>
+          </requirement>
+      </requirement_set>
+    </requirement_group>
+
+    <requirement_group id="System Interfaces">
+      <requirement_set caption="Interface with external applications">
+          <requirement id_code="R-SI-1">
+              <description>HYBRID-based models shall be able to be coupled with external applications via input files</description>
+          </requirement>
+          <requirement id_code="R-SI-2">
+              <description>HYBRID-based models shall be able to be coupled with standardized interface (FMI and FMU)</description>
+          </requirement>
+      </requirement_set>
+    </requirement_group>
+
+</requirements_specification>
+
+

doc/user_manual/hybrid_user_manual.blg

@@ -1,9 +1,7 @@
-This is BibTeX, Version 0.99d
-Capacity: max_strings=200000, hash_size=200000, hash_prime=170003
+This is BibTeX, Version 0.99d (TeX Live 2016)
+Capacity: max_strings=35307, hash_size=35307, hash_prime=30011
 The top-level auxiliary file: hybrid_user_manual.aux
-Reallocating 'name_of_file' (item size: 1) to 7 items.
 The style file: ieeetr.bst
-Reallocating 'name_of_file' (item size: 1) to 11 items.
 Database file #1: References.bib
 Warning--empty journal in TRANSFORM
 You've used 17 entries,

doc/user_manual/hybrid_user_manual.toc

@@ -1,37 +1,37 @@
-\contentsline {section}{\numberline {1}Introduction}{1}{section.1}%
-\contentsline {subsection}{\numberline {1.1}Modelica Models}{1}{subsection.1.1}%
-\contentsline {subsection}{\numberline {1.2}Individual Components}{1}{subsection.1.2}%
-\contentsline {subsection}{\numberline {1.3}Hybrid Requirements}{2}{subsection.1.3}%
-\contentsline {section}{\numberline {2}HYBRID Installation Procedure}{3}{section.2}%
-\contentsline {subsection}{\numberline {2.1}Overview}{3}{subsection.2.1}%
-\contentsline {subsection}{\numberline {2.2}Cloning the Hybrid Repository}{3}{subsection.2.2}%
-\contentsline {subsubsection}{\numberline {2.2.1}Install RAVEN and its plugins as a sub-module}{4}{subsubsection.2.2.1}%
-\contentsline {subsubsection}{\numberline {2.2.2}Inform the Framework Paths}{4}{subsubsection.2.2.2}%
-\contentsline {subsection}{\numberline {2.3}Setup of Dymola for the Regression Testing System}{5}{subsection.2.3}%
-\contentsline {subsection}{\numberline {2.4}Run Regression tests related to the HYBRID project}{5}{subsection.2.4}%
-\contentsline {section}{\numberline {3}Running and Creating New Code}{8}{section.3}%
-\contentsline {subsection}{\numberline {3.1}Understanding and Running Existing Models}{8}{subsection.3.1}%
-\contentsline {subsubsection}{\numberline {3.1.1}Modifying Existing Models for Specific Runs}{12}{subsubsection.3.1.1}%
-\contentsline {subsection}{\numberline {3.2}Configuring Existing Models into Integrated Energy Systems}{13}{subsection.3.2}%
-\contentsline {subsection}{\numberline {3.3}Test Creation}{16}{subsection.3.3}%
-\contentsline {subsection}{\numberline {3.4}Advanced Test File Options utilized for complex models}{22}{subsection.3.4}%
-\contentsline {section}{\numberline {4}Model Description}{25}{section.4}%
-\contentsline {subsection}{\numberline {4.1}Primary Heat System}{25}{subsection.4.1}%
-\contentsline {subsubsection}{\numberline {4.1.1}Four Loop Pressurized Water Reactor}{25}{subsubsection.4.1.1}%
-\contentsline {subsubsection}{\numberline {4.1.2}Generic Modular PWR}{25}{subsubsection.4.1.2}%
-\contentsline {subsubsection}{\numberline {4.1.3}Natural Circulation Small Modular Reactor}{26}{subsubsection.4.1.3}%
-\contentsline {subsection}{\numberline {4.2}Energy Manifold}{27}{subsection.4.2}%
-\contentsline {subsection}{\numberline {4.3}Industrial Process}{28}{subsection.4.3}%
-\contentsline {subsubsection}{\numberline {4.3.1}Hydrogen Production}{28}{subsubsection.4.3.1}%
-\contentsline {subsubsection}{\numberline {4.3.2}Desalination}{30}{subsubsection.4.3.2}%
-\contentsline {subsection}{\numberline {4.4}Balance of Plant}{30}{subsection.4.4}%
-\contentsline {subsubsection}{\numberline {4.4.1}Simple Balance of Plant}{31}{subsubsection.4.4.1}%
-\contentsline {subsubsection}{\numberline {4.4.2}Step Down Turbines}{31}{subsubsection.4.4.2}%
-\contentsline {subsection}{\numberline {4.5}Energy Storage}{31}{subsection.4.5}%
-\contentsline {subsubsection}{\numberline {4.5.1}Electric Battery Storage}{32}{subsubsection.4.5.1}%
-\contentsline {subsubsection}{\numberline {4.5.2}Two-Tank Thermal Energy Storage}{32}{subsubsection.4.5.2}%
-\contentsline {subsubsection}{\numberline {4.5.3}Thermocline Packed Bed Thermal Energy Storage}{34}{subsubsection.4.5.3}%
-\contentsline {subsection}{\numberline {4.6}Secondary Energy Source}{35}{subsection.4.6}%
-\contentsline {subsubsection}{\numberline {4.6.1}Natural Gas Fired Turbine}{35}{subsubsection.4.6.1}%
-\contentsline {subsubsection}{\numberline {4.6.2}Hydrogen Turbine}{36}{subsubsection.4.6.2}%
-\contentsline {section}{References}{39}{section*.31}%
+\contentsline {section}{\numberline {1}Introduction}{1}{section.1}
+\contentsline {subsection}{\numberline {1.1}Modelica Models}{1}{subsection.1.1}
+\contentsline {subsection}{\numberline {1.2}Individual Components}{1}{subsection.1.2}
+\contentsline {subsection}{\numberline {1.3}Hybrid Requirements}{2}{subsection.1.3}
+\contentsline {section}{\numberline {2}HYBRID Installation Procedure}{3}{section.2}
+\contentsline {subsection}{\numberline {2.1}Overview}{3}{subsection.2.1}
+\contentsline {subsection}{\numberline {2.2}Cloning the Hybrid Repository}{3}{subsection.2.2}
+\contentsline {subsubsection}{\numberline {2.2.1}Install RAVEN and its plugins as a sub-module}{4}{subsubsection.2.2.1}
+\contentsline {subsubsection}{\numberline {2.2.2}Inform the Framework Paths}{4}{subsubsection.2.2.2}
+\contentsline {subsection}{\numberline {2.3}Setup of Dymola for the Regression Testing System}{5}{subsection.2.3}
+\contentsline {subsection}{\numberline {2.4}Run Regression tests related to the HYBRID project}{5}{subsection.2.4}
+\contentsline {section}{\numberline {3}Running and Creating New Code}{8}{section.3}
+\contentsline {subsection}{\numberline {3.1}Understanding and Running Existing Models}{8}{subsection.3.1}
+\contentsline {subsubsection}{\numberline {3.1.1}Modifying Existing Models for Specific Runs}{12}{subsubsection.3.1.1}
+\contentsline {subsection}{\numberline {3.2}Configuring Existing Models into Integrated Energy Systems}{13}{subsection.3.2}
+\contentsline {subsection}{\numberline {3.3}Test Creation}{16}{subsection.3.3}
+\contentsline {subsection}{\numberline {3.4}Advanced Test File Options utilized for complex models}{22}{subsection.3.4}
+\contentsline {section}{\numberline {4}Model Description}{25}{section.4}
+\contentsline {subsection}{\numberline {4.1}Primary Heat System}{25}{subsection.4.1}
+\contentsline {subsubsection}{\numberline {4.1.1}Four Loop Pressurized Water Reactor}{25}{subsubsection.4.1.1}
+\contentsline {subsubsection}{\numberline {4.1.2}Generic Modular PWR}{25}{subsubsection.4.1.2}
+\contentsline {subsubsection}{\numberline {4.1.3}Natural Circulation Small Modular Reactor}{26}{subsubsection.4.1.3}
+\contentsline {subsection}{\numberline {4.2}Energy Manifold}{27}{subsection.4.2}
+\contentsline {subsection}{\numberline {4.3}Industrial Process}{28}{subsection.4.3}
+\contentsline {subsubsection}{\numberline {4.3.1}Hydrogen Production}{28}{subsubsection.4.3.1}
+\contentsline {subsubsection}{\numberline {4.3.2}Desalination}{30}{subsubsection.4.3.2}
+\contentsline {subsection}{\numberline {4.4}Balance of Plant}{30}{subsection.4.4}
+\contentsline {subsubsection}{\numberline {4.4.1}Simple Balance of Plant}{31}{subsubsection.4.4.1}
+\contentsline {subsubsection}{\numberline {4.4.2}Step Down Turbines}{31}{subsubsection.4.4.2}
+\contentsline {subsection}{\numberline {4.5}Energy Storage}{31}{subsection.4.5}
+\contentsline {subsubsection}{\numberline {4.5.1}Electric Battery Storage}{32}{subsubsection.4.5.1}
+\contentsline {subsubsection}{\numberline {4.5.2}Two-Tank Thermal Energy Storage}{32}{subsubsection.4.5.2}
+\contentsline {subsubsection}{\numberline {4.5.3}Thermocline Packed Bed Thermal Energy Storage}{34}{subsubsection.4.5.3}
+\contentsline {subsection}{\numberline {4.6}Secondary Energy Source}{35}{subsection.4.6}
+\contentsline {subsubsection}{\numberline {4.6.1}Natural Gas Fired Turbine}{35}{subsubsection.4.6.1}
+\contentsline {subsubsection}{\numberline {4.6.2}Hydrogen Turbine}{36}{subsubsection.4.6.2}
+\contentsline {section}{References}{39}{section*.31}

doc/version.tex

@@ -1 +1 @@
-cb7e68b7e1757a4b957e18af7a6bdaa613d514b3 klfrick2 Mon, 15 Feb 2021 09:01:17 -0700
+09a34b32ae7a18d79261047cb9da2e7e7d35523a alfoa Mon, 15 Mar 2021 14:09:50 -0600