Adds diagrams jlu-ilr-hydro#16

docs/build/html/_sources/odmf/about.md.txt

@@ -17,7 +17,7 @@ the CUAHSI organization. For example to inspect or download data via the [Data.C
 
 ## Development
 
-Further explanation is in [development chapter](development.html).
+Further explanation on the code structure and software components in [development chapter](development.html).
 (Architecture/ Components) Link to Development
 Mentales Gerüst (optional)
 
@@ -30,7 +30,11 @@ Mentales Gerüst (optional)
 
 ### How does it work
 
-Elements are HydroServerLite (a) which implements the WaterOneFlow interface, the PostgreSQL database (b) which fullfills the ODM schema, via SQL views. And the ODMF (c) server is mainly used to write data into the database.
+The important elements are HydroServerLite (a) which implements the WaterOneFlow interface,
+the PostgreSQL database (b) which fullfills the ODM schema, via SQL views. Additionally there
+is the ODMF (c) server, which is mainly used to write data into the database.
+
+![FMC diagram of whole system]( ../../images/fmc-cuahsi.png "Different components (FMC diagram)")
 
 1. A request is send to the HydroServer.
 
@@ -41,9 +45,7 @@ Elements are HydroServerLite (a) which implements the WaterOneFlow interface, th
 Data writes from the import mechanism from the ODMF server are an ongoing process and can result in an hourly changing
 data base.
 
-<!-- TODO fmc diagram (a) - (b) - (c) -->
-
-<!-- TODO fmc transaction diagram -->
+![UML transaction diagram]( ../../images/fmc-wof-views-2.png "UML transactions from request (FMC Diagram)")
 
 ### Implementation
 

docs/build/html/_sources/odmf/development.md.txt

@@ -14,11 +14,17 @@ connects the [postgres](https://postgres.org) database and renders with the help
 Speaking of the server code, the database is accessed consistently via the ORM-mapping framework [sqlalchemy](https://www.sqlalchemy.org).
 The Cherrypy server also exposes some methods as JSON exports for a rest-like use of data retrieval.
 
-![Picture of the ODMF database schema]( ../../images/umls/server-stack.jpg "ODMF server stack")
+<!-- TODO very high level fmc -->
+
+![High level server stack]( ../../images/fmc-highlevel.png "ODMF high level server stack (FMC diagram)")
 
 The development was done between 2013-today partially by a team of one or two developers. There are some acceptance
 and ui tests, but no unit tests.
 
+## Structure
+
+![ODMF software components](../../images/fmc-odmf.png "ODMF software components (FMC diagram)")
+
 The code base is divided in three main parts. **Server**, **automated import** and
 **database communication**.
 

docs/build/html/index.html

@@ -203,6 +203,7 @@ <h1>ODMF Docs<a class="headerlink" href="#odmf-docs" title="Permalink to this he
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="odmf/development.html">Development</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="odmf/development.html#structure">Structure</a></li>
 <li class="toctree-l2"><a class="reference internal" href="odmf/development.html#core-thoughts-behind-design-decisions">Core thoughts behind design decisions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="odmf/development.html#database-orm-mapping">Database (ORM mapping)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="odmf/development.html#database-sql">Database (SQL)</a></li>

docs/build/html/odmf/about.html

@@ -182,7 +182,7 @@
 </div>
 <div class="section" id="development">
 <span id="development"></span><h2>Development<a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h2>
-<p>Further explanation is in <a class="reference external" href="development.html">development chapter</a>.
+<p>Further explanation on the code structure and software components in <a class="reference external" href="development.html">development chapter</a>.
 (Architecture/ Components) Link to Development
 Mentales Gerüst (optional)</p>
 <ul class="simple">
@@ -194,15 +194,19 @@
 <span id="cuahsi-wateroneflow-interface"></span><h2>CUAHSI WaterOneFlow Interface<a class="headerlink" href="#cuahsi-wateroneflow-interface" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="how-does-it-work">
 <span id="how-does-it-work"></span><h3>How does it work<a class="headerlink" href="#how-does-it-work" title="Permalink to this headline">¶</a></h3>
-<p>Elements are HydroServerLite (a) which implements the WaterOneFlow interface, the PostgreSQL database (b) which fullfills the ODM schema, via SQL views. And the ODMF (c) server is mainly used to write data into the database.</p>
+<p>The important elements are HydroServerLite (a) which implements the WaterOneFlow interface,
+the PostgreSQL database (b) which fullfills the ODM schema, via SQL views. Additionally there
+is the ODMF (c) server, which is mainly used to write data into the database.</p>
+<p><img alt="FMC diagram of whole system" src="../_images/fmc-cuahsi.png" /></p>
 <ol class="simple">
 <li>A request is send to the HydroServer.</li>
 <li>The responses are build of information from one ore more views, which the server middleware will compose.</li>
 <li>The middleware calls request the database for the respective views.</li>
 </ol>
 <p>Data writes from the import mechanism from the ODMF server are an ongoing process and can result in an hourly changing
 data base.</p>
-<!-- TODO fmc diagram (a) - (b) - (c) --><!-- TODO fmc transaction diagram --></div>
+<p><img alt="UML transaction diagram" src="../_images/fmc-wof-views-2.png" /></p>
+</div>
 <div class="section" id="implementation">
 <span id="implementation"></span><h3>Implementation<a class="headerlink" href="#implementation" title="Permalink to this headline">¶</a></h3>
 <p>Details on this topic are written down in <a class="reference external" href="development.html#wateroneflow">development chapter</a></p>

docs/build/html/odmf/development.html

@@ -88,6 +88,7 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage/ Tutorial/ Wiki</a></li>
 <li class="toctree-l1"><a class="reference internal" href="views.html">Views</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Development</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#structure">Structure</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#core-thoughts-behind-design-decisions">Core thoughts behind design decisions</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#database-erm">Database (ERM)</a></li>
 </ul>
@@ -195,9 +196,12 @@
 <a class="reference external" href="https://genshi.edgewall.org/">genshi</a> the HTML content and a bit of <a class="reference external" href="https://jquery.org">jquery</a>.
 Speaking of the server code, the database is accessed consistently via the ORM-mapping framework <a class="reference external" href="https://www.sqlalchemy.org">sqlalchemy</a>.
 The Cherrypy server also exposes some methods as JSON exports for a rest-like use of data retrieval.</p>
-<p><img alt="Picture of the ODMF database schema" src="../_images/server-stack.jpg" /></p>
+<!-- TODO very high level fmc --><p><img alt="High level server stack" src="../_images/fmc-highlevel.png" /></p>
 <p>The development was done between 2013-today partially by a team of one or two developers. There are some acceptance
 and ui tests, but no unit tests.</p>
+<div class="section" id="structure">
+<span id="structure"></span><h2>Structure<a class="headerlink" href="#structure" title="Permalink to this headline">¶</a></h2>
+<p><img alt="ODMF software components" src="../_images/fmc-odmf.png" /></p>
 <p>The code base is divided in three main parts. <strong>Server</strong>, <strong>automated import</strong> and
 <strong>database communication</strong>.</p>
 <ul class="simple">
@@ -212,6 +216,7 @@
 <li><strong>database</strong> and ORM code is in <code class="docutils literal notranslate"><span class="pre">db</span></code> the module.</li>
 </ul>
 <p>Utility code for calibration, conf and markdown parsing are saved in the <code class="docutils literal notranslate"><span class="pre">tools</span></code> module.</p>
+</div>
 <div class="section" id="core-thoughts-behind-design-decisions">
 <span id="core-thoughts-behind-design-decisions"></span><h2>Core thoughts behind design decisions<a class="headerlink" href="#core-thoughts-behind-design-decisions" title="Permalink to this headline">¶</a></h2>
 <p>To connect more of the ideas under the hood of the server there are diagrams describing the user interaction for the most important functions of the platform.</p>

docs/docs/source/odmf/about.md

@@ -17,7 +17,7 @@ the CUAHSI organization. For example to inspect or download data via the [Data.C
 
 ## Development
 
-Further explanation is in [development chapter](development.html).
+Further explanation on the code structure and software components in [development chapter](development.html).
 (Architecture/ Components) Link to Development
 Mentales Gerüst (optional)
 
@@ -30,7 +30,11 @@ Mentales Gerüst (optional)
 
 ### How does it work
 
-Elements are HydroServerLite (a) which implements the WaterOneFlow interface, the PostgreSQL database (b) which fullfills the ODM schema, via SQL views. And the ODMF (c) server is mainly used to write data into the database.
+The important elements are HydroServerLite (a) which implements the WaterOneFlow interface,
+the PostgreSQL database (b) which fullfills the ODM schema, via SQL views. Additionally there
+is the ODMF (c) server, which is mainly used to write data into the database.
+
+![FMC diagram of whole system]( ../../images/fmc-cuahsi.png "Different components (FMC diagram)")
 
 1. A request is send to the HydroServer.
 
@@ -41,9 +45,7 @@ Elements are HydroServerLite (a) which implements the WaterOneFlow interface, th
 Data writes from the import mechanism from the ODMF server are an ongoing process and can result in an hourly changing
 data base.
 
-<!-- TODO fmc diagram (a) - (b) - (c) -->
-
-<!-- TODO fmc transaction diagram -->
+![UML transaction diagram]( ../../images/fmc-wof-views-2.png "UML transactions from request (FMC Diagram)")
 
 ### Implementation
 

docs/docs/source/odmf/development.md

@@ -14,11 +14,17 @@ connects the [postgres](https://postgres.org) database and renders with the help
 Speaking of the server code, the database is accessed consistently via the ORM-mapping framework [sqlalchemy](https://www.sqlalchemy.org).
 The Cherrypy server also exposes some methods as JSON exports for a rest-like use of data retrieval.
 
-![Picture of the ODMF database schema]( ../../images/umls/server-stack.jpg "ODMF server stack")
+<!-- TODO very high level fmc -->
+
+![High level server stack]( ../../images/fmc-highlevel.png "ODMF high level server stack (FMC diagram)")
 
 The development was done between 2013-today partially by a team of one or two developers. There are some acceptance
 and ui tests, but no unit tests.
 
+## Structure
+
+![ODMF software components](../../images/fmc-odmf.png "ODMF software components (FMC diagram)")
+
 The code base is divided in three main parts. **Server**, **automated import** and
 **database communication**.