docs for b73b8d6 commit

INTO-CPS-Association · Nov 17, 2023 · 5d423e2 · 5d423e2
1 parent 62e74ef
commit 5d423e2
Show file tree

Hide file tree

Showing 12 changed files with 106 additions and 84 deletions.
diff --git a/DTaaS-development.pdf b/DTaaS-development.pdf
diff --git a/development/admin/overview.html b/development/admin/overview.html
@@ -404,17 +404,17 @@
 
         <li class="md-nav__item">
   <a href="#what-is-the-goal" class="md-nav__link">
-    What is the goal
+    What is the goal?
   </a>
 
 </li>
 
         <li class="md-nav__item">
   <a href="#what-are-the-requirements" class="md-nav__link">
-    What are the requirements
+    What are the requirements?
   </a>
 
-    <nav class="md-nav" aria-label="What are the requirements">
+    <nav class="md-nav" aria-label="What are the requirements?">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -445,7 +445,7 @@
 
         <li class="md-nav__item">
   <a href="#what-to-install" class="md-nav__link">
-    What to install
+    What to install?
   </a>
 
 </li>
@@ -1301,17 +1301,17 @@
 
         <li class="md-nav__item">
   <a href="#what-is-the-goal" class="md-nav__link">
-    What is the goal
+    What is the goal?
   </a>
 
 </li>
 
         <li class="md-nav__item">
   <a href="#what-are-the-requirements" class="md-nav__link">
-    What are the requirements
+    What are the requirements?
   </a>
 
-    <nav class="md-nav" aria-label="What are the requirements">
+    <nav class="md-nav" aria-label="What are the requirements?">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -1342,7 +1342,7 @@
 
         <li class="md-nav__item">
   <a href="#what-to-install" class="md-nav__link">
-    What to install
+    What to install?
   </a>
 
 </li>
@@ -1366,11 +1366,11 @@
 
 
 <h1 id="overview">Overview</h1>
-<h2 id="what-is-the-goal">What is the goal</h2>
+<h2 id="what-is-the-goal">What is the goal?</h2>
 <p>The goal is to set up the DTaaS infrastructure in order to enable
 your users to use the DTaaS.
 As an admin you will administrate the users and the servers of the system.</p>
-<h2 id="what-are-the-requirements">What are the requirements</h2>
+<h2 id="what-are-the-requirements">What are the requirements?</h2>
 <h3 id="oauth-provider">OAuth Provider</h3>
 <p>You need to have an OAuth Provider running, which the DTaaS can use for
 authentication. This is described further in
@@ -1387,7 +1387,7 @@ <h3 id="reverse-proxy">Reverse Proxy</h3>
 <a href="client/CLIENT.html">client .env file</a> and in
 <a href="client/auth.html">OAuth registration</a>. Other installation configuration
 remains the same.</p>
-<h2 id="what-to-install">What to install</h2>
+<h2 id="what-to-install">What to install?</h2>
 <p>The DTaaS can be installed in different ways. Each version is for different purposes:</p>
 <ul>
 <li><a href="trial.html">Trial installation on single host</a></li>
@@ -1397,7 +1397,7 @@ <h2 id="what-to-install">What to install</h2>
 <li>Seperater Packages: <a href="client/CLIENT.html">client website</a> and
   <a href="servers/lib/LIB-MS.html">lib microservice</a></li>
 </ul>
-<p>Following the installation that fit your usecase.</p>
+<p>Follow the installation that fits your usecase.</p>
 
 
 

diff --git a/development/index.html b/development/index.html
@@ -1279,7 +1279,7 @@
 
 
 
-<h1 id="what-is-dtaas">What is DTaaS</h1>
+<h1 id="what-is-dtaas">What is DTaaS?</h1>
 <p>The Digital Twin as a Service (DTaaS) software platform is useful
 to <font color="orange"> <strong>Build, Use and Share</strong> </font> digital twins (DTs).</p>
 <p><img alt="🦾" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/1f9be.svg" title=":mechanical_arm:" /> <font color="orange"><strong>Build</strong></font>: The

diff --git a/development/search/search_index.json b/development/search/search_index.json
diff --git a/development/sitemap.xml.gz b/development/sitemap.xml.gz
diff --git a/development/user/examples/drobotti-rmqfmu/dt-structure.png b/development/user/examples/drobotti-rmqfmu/dt-structure.png
diff --git a/development/user/examples/drobotti-rmqfmu/index.html b/development/user/examples/drobotti-rmqfmu/index.html
@@ -945,8 +945,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#configuration-of-assets" class="md-nav__link">
-    Configuration of assets
+  <a href="#digital-twin-configuration" class="md-nav__link">
+    Digital Twin Configuration
   </a>
 
 </li>
@@ -1350,8 +1350,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#configuration-of-assets" class="md-nav__link">
-    Configuration of assets
+  <a href="#digital-twin-configuration" class="md-nav__link">
+    Digital Twin Configuration
   </a>
 
 </li>
@@ -1467,7 +1467,7 @@ <h2 id="example-structure">Example Structure</h2>
 The distance FMU is responsible for calculating the distance between
 <em>(0,0)</em> and <em>(x,y)</em>. The RMQ FMU and distance FMU exchange values
 during co-simulation.</p>
-<h2 id="configuration-of-assets">Configuration of assets</h2>
+<h2 id="digital-twin-configuration">Digital Twin Configuration</h2>
 <p>This example uses two models, one tool, one data, and two scripts to create
 mock physical twin. The specific assets used are:</p>
 <table>
@@ -1520,9 +1520,11 @@ <h2 id="configuration-of-assets">Configuration of assets</h2>
 </table>
 <p>This DT has many configuration files.
 The <code>coe.json</code> and <code>multimodel.json</code>
-are two DT configuration files used for executing the digital twin.</p>
-<p>The <code>rabbitMQ-credentials.json</code> provides RabbitMQ access credentials
-for mock PT python scripts.</p>
+are two DT configuration files used for executing the digital twin.
+You can change these two files to customize the DT to your needs.</p>
+<p>The RabbitMQ access credentials need to be provided in <code>multimodel.json</code>.
+The <code>rabbitMQ-credentials.json</code> provides RabbitMQ access credentials
+for mock PT python scripts. Please add your credentials in both these files.</p>
 <h2 id="lifecycle-phases">Lifecycle Phases</h2>
 <table>
 <thead>
@@ -1548,7 +1550,7 @@ <h2 id="lifecycle-phases">Lifecycle Phases</h2>
 </table>
 <h2 id="run-the-example">Run the example</h2>
 <p>To run the example, change your present directory.</p>
-<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nb">cd</span><span class="w"> </span>workspace/examples/digital_twins/drobotti_rmqfmu
+<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nb">cd</span><span class="w"> </span>/workspace/examples/digital_twins/drobotti_rmqfmu
 </span></code></pre></div></td></tr></table></div>
 <p>If required, change the execute permission of lifecycle scripts
 you need to execute, for example:</p>
@@ -1562,18 +1564,23 @@ <h3 id="create">Create</h3>
 <div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a>lifecycle/create
 </span></code></pre></div></td></tr></table></div>
 <h3 id="execute">Execute</h3>
-<p>Run the python scripts to start mock physical twin. Also run the co-simulation for
-the digital twin.</p>
+<p>Run the python scripts to start mock physical twin.
+Also run the the Digital Twin. Since this is a co-simulation based
+digital twin, the Maestro co-simulation tool executes co-simulation
+using the two FMU models.</p>
 <div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-3-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1"></a>lifecycle/execute
 </span></code></pre></div></td></tr></table></div>
 <h4 id="examine-the-results">Examine the results</h4>
 <p>The results can be found in the
-<em>workspace/examples/digital_twins/drobotti_rmqfmu directory</em>.</p>
+<em>/workspace/examples/digital_twins/drobotti_rmqfmu directory</em>.</p>
 <h3 id="terminate-phase">Terminate phase</h3>
 <p>Terminate to clean up the debug files and co-simulation output files.</p>
 <div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-4-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1"></a>lifecycle/terminate
 </span></code></pre></div></td></tr></table></div>
 <h2 id="references">References</h2>
+<p>The <a href="https://github.com/INTO-CPS-Association/fmu-rabbitmq">RabbitMQ FMU</a>
+github repository contains complete documentation and source code of
+the rmq-vhost.fmu.</p>
 <p>More information about the case study is available in:</p>
 <div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-5-1">1</a></span>
 <span class="normal"><a href="#__codelineno-5-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1"></a>Frasheri, Mirgita, et al. &quot;Addressing time discrepancy between digital

diff --git a/development/user/examples/examples.drawio b/development/user/examples/examples.drawio
diff --git a/development/user/examples/index.html b/development/user/examples/index.html
@@ -1320,6 +1320,7 @@ <h2 id="example-list">Example List</h2>
 <li><a href="mass-spring-damper/index.html">Mass Spring Damper</a></li>
 <li><a href="water_tank_FI/index.html">Water Tank Fault Injection</a></li>
 <li><a href="water_tank_swap/index.html">Water Tank Model Swap</a></li>
+<li><a href="drobotti-rmqfmu/index.html">Desktop Robotti and RabbitMQ</a></li>
 </ol>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M5 20h14v-2H5m14-9h-4V3H9v6H5l7 7 7-7Z"/></svg></span> <a href="https://github.com/INTO-CPS-Association/DTaaS-examples">DTaaS examples</a></p>
 

diff --git a/development/user/examples/mass-spring-damper/index.html b/development/user/examples/mass-spring-damper/index.html
@@ -910,8 +910,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#configuration-of-assets" class="md-nav__link">
-    Configuration of assets
+  <a href="#digital-twin-configuration" class="md-nav__link">
+    Digital Twin Configuration
   </a>
 
 </li>
@@ -1364,8 +1364,8 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#configuration-of-assets" class="md-nav__link">
-    Configuration of assets
+  <a href="#digital-twin-configuration" class="md-nav__link">
+    Digital Twin Configuration
   </a>
 
 </li>
@@ -1463,7 +1463,7 @@ <h2 id="example-structure">Example Structure</h2>
 mass <script type="math/tex">m_1</script>. By coupling these simulators, the evolution of the position of
 the two masses is computed.</p>
 <p><img alt="Mass Spring Damper Structure" src="dt-structure.png" /></p>
-<h2 id="configuration-of-assets">Configuration of assets</h2>
+<h2 id="digital-twin-configuration">Digital Twin Configuration</h2>
 <p>This example uses two models and one tool. The specific assets used are:</p>
 <table>
 <thead>
@@ -1496,7 +1496,8 @@ <h2 id="configuration-of-assets">Configuration of assets</h2>
 </tbody>
 </table>
 <p>The <code>co-sim.json</code> and <code>time.json</code>
-are two DT configuration files used for executing the digital twin.</p>
+are two DT configuration files used for executing the digital twin.
+You can change these two files to customize the DT to your needs.</p>
 <h2 id="lifecycle-phases">Lifecycle Phases</h2>
 <table>
 <thead>
@@ -1522,7 +1523,7 @@ <h2 id="lifecycle-phases">Lifecycle Phases</h2>
 </table>
 <h2 id="run-the-example">Run the example</h2>
 <p>To run the example, change your present directory.</p>
-<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nb">cd</span><span class="w"> </span>workspace/examples/digital_twins/mass-spring-damper
+<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nb">cd</span><span class="w"> </span>/workspace/examples/digital_twins/mass-spring-damper
 </span></code></pre></div></td></tr></table></div>
 <p>If required, change the execute permission of lifecycle scripts
 you need to execute, for example:</p>
@@ -1534,17 +1535,16 @@ <h3 id="create">Create</h3>
 <div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a>lifecycle/create
 </span></code></pre></div></td></tr></table></div>
 <h3 id="execute">Execute</h3>
-<p>Run the co-simulation. Generate the co-simulation output.csv file
-at <code>data/mass-spring-damper/output/output.csv</code>.</p>
-<p>There are also debug and maestro log files stored in
-<code>data/mass-spring-damper/output</code> directory.</p>
+<p>Run the the Digital Twin. Since this is a co-simulation based
+digital twin, the Maestro co-simulation tool executes co-simulation
+using the two FMU models.</p>
 <div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-3-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1"></a>lifecycle/execute
 </span></code></pre></div></td></tr></table></div>
 <h4 id="examine-the-results">Examine the results</h4>
 <p>The results can be found in the
-<em>workspace/examples/data/mass-spring-damper/output directory</em>.</p>
+<em>/workspace/examples/data/mass-spring-damper/output directory</em>.</p>
 <p>You can also view run logs in the
-<em>workspace/examples/digital_twins/mass-spring-damper</em>.</p>
+<em>/workspace/examples/digital_twins/mass-spring-damper</em>.</p>
 <h3 id="terminate-phase">Terminate phase</h3>
 <p>Terminate to clean up the debug files and co-simulation output files.</p>
 <div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-4-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1"></a>lifecycle/terminate
@@ -1556,6 +1556,9 @@ <h2 id="references">References</h2>
 <span class="normal"><a href="#__codelineno-5-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1"></a>Gomes, Cláudio, et al. &quot;Co-simulation: State of the art.&quot;
 </span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2"></a>arXiv preprint arXiv:1702.00686 (2017).
 </span></code></pre></div></td></tr></table></div>
+<p>The source code for the models used in this DT are available in
+<a href="https://github.com/INTO-CPS-Association/example-mass_spring_damper">mass spring damper</a>
+github repository.</p>