Updated documentation of Examples package

This adds more information to the top-level documentation of IBPSA.Examples
ibpsa · Oct 24, 2023 · 9c13368 · 9c13368
1 parent bea2228
commit 9c13368
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/IBPSA/Examples/package.mo b/IBPSA/Examples/package.mo
@@ -3,9 +3,20 @@ package Examples "Collection of models that illustrate model use and test models
   extends Modelica.Icons.ExamplesPackage;
 annotation (preferredView="info", Documentation(info="<html>
 <p>
-This package contains examples for the use of models that can be found in
-<a href=\"modelica://IBPSA\">
-IBPSA</a>.
+This package contains examples and tutorials with step-by-step instructions
+for how to build system models.
+</p>
+<p>
+The examples illustrate
+the scope of the library. Smaller examples that typically only
+use models from a few packages can be found in the individual packages.
+For example, see
+<a href=\"modelica://Buildings.Airflow.Multizone.Examples\">
+Buildings.Airflow.Multizone.Examples</a> for examples of
+multizone airflow and contaminant transport models, or
+<a href=\"modelica://IBPSA.Fluid.HeatExchangers.Examples\">
+IBPSA.Fluid.HeatExchangers.Examples</a> for
+examples of heat exchanger models.
 </p>
 </html>"));
 end Examples;