Merge pull request #47 from rhuygen/main

Updates to developer, user, and installation manuals. See the Changelog of the individual manuals.

README.md

@@ -30,13 +30,24 @@ Other manuals are created with the same commands.
 
 Now move the HTML files for each of the manuals to the `docs/asciidocs` folder so they become part of the GitHub pages.
 
-The site also provides the API documentation of the Common-EGSE. This documentation shall be generated in the `plato-common-egse` repository. Go into the `MKDOCS` folder and run the following command:
+The site also provides the API documentation of the Common-EGSE. This documentation shall be generated in the `plato-common-egse` repository. Go into the root folder of the project and run the following command:
 ```
 $ pdoc3 --html --output-dir api egse --force
+```
+or
+```
 $ pdoc3 --html --output-dir ~/Documents/PyCharmProjects/plato-cgse-doc/docs/api egse --force
 ```
 The move the `api` folder from the `plato-common-egse` repo into the `docs` folder of this repo.
 
+If you need to exclude certain modules from the API documentation, create the `__pdoc__` variable in the __init__.py of that module. As an example, exclude the `eksma` module from the `egse.filterwheel`, add the following lines in the `__init__.py` of the `egse.filterwheel` module.
+
+```
+__pdoc__ = {
+    'eksma': False
+}
+```
+
 You are now ready to commit and push the updated documentation or to make a pull request. The site will automatically be uploaded to the GitHub pages and be available at [github.io](https://ivs-kuleuven.github.io/plato-cgse-doc/).
 
 If you are using PyCharm, updating this documentation is easiest if you install the `Asciidoc` plugin in PyCharm. That will allow you to generate the HTML and PDF documents with just one click.
@@ -47,3 +58,27 @@ Where do we need to update versions before pushing changes:
 * In each of the main files: icd.adoc, installation-manual.adoc, developer-manual.adoc, and user-manual.adoc
 * In the `changelog.adoc` file for each of the manuals
 * In the HUGO content `posts` and /or `docs` for those manuals that were updated. 
+
+## Installation of AsciiDoctor on macOS
+
+Make sure you have the `ruby` command from brew in your path instead of the system provided version.
+
+See https://docs.asciidoctor.org/asciidoctor/latest/install/
+```
+$ brew install asciidoctor
+```
+
+Then, install asciidoctor-pdf, see https://github.com/asciidoctor/asciidoctor-pdf
+```
+$ gem install asciidoctor-pdf
+```
+
+Then, install asciidoctor-tabs, see https://github.com/asciidoctor/asciidoctor-tabs
+```
+gem install [--prerelease] asciidoctor-tabs
+```
+
+Install HUGO:
+```
+$ brew install hugo 
+```

docs/404.html

@@ -7,7 +7,7 @@
     <title>The Common-EGSE Documentation</title>
     <meta name="viewport" content="width=device-width,minimum-scale=1">
     <meta name="description" content="The CGSE Documentation Site.">
-    <meta name="generator" content="Hugo 0.110.0">
+    <meta name="generator" content="Hugo 0.121.2">
 
 
 
@@ -33,9 +33,9 @@
 <meta property="og:description" content="The CGSE Documentation Site." />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://ivs-kuleuven.github.io/plato-cgse-doc/404.html" />
+
 <meta itemprop="name" content="404 Page not found">
-<meta itemprop="description" content="The CGSE Documentation Site."><meta name="twitter:card" content="summary"/>
-<meta name="twitter:title" content="404 Page not found"/>
+<meta itemprop="description" content="The CGSE Documentation Site."><meta name="twitter:card" content="summary"/><meta name="twitter:title" content="404 Page not found"/>
 <meta name="twitter:description" content="The CGSE Documentation Site."/>
 
 
@@ -163,7 +163,7 @@ <h1>
     <footer class="bg-dark-gray bottom-0 w-100 pa3" role="contentinfo">
   <div class="flex justify-between">
   <a class="f4 fw4 hover-white no-underline white-70 dn dib-ns pv2 ph3" href="https://ivs-kuleuven.github.io/plato-cgse-doc/" >
-    &copy;  The Common-EGSE Documentation 2023 
+    &copy;  The Common-EGSE Documentation 2024 
   </a>
     <div>
 <div class="ananke-socials">

docs/about/index.html

@@ -7,7 +7,7 @@
     <title>About | The Common-EGSE Documentation</title>
     <meta name="viewport" content="width=device-width,minimum-scale=1">
     <meta name="description" content="Good code is its own best documentation — Steve McConnell">
-    <meta name="generator" content="Hugo 0.110.0">
+    <meta name="generator" content="Hugo 0.121.2">
 
 
 
@@ -35,12 +35,12 @@
 <meta property="og:url" content="https://ivs-kuleuven.github.io/plato-cgse-doc/about/" /><meta property="article:section" content="" />
 
 
+
 <meta itemprop="name" content="About">
 <meta itemprop="description" content="Good code is its own best documentation — Steve McConnell">
 
 <meta itemprop="wordCount" content="246">
-<meta itemprop="keywords" content="" /><meta name="twitter:card" content="summary"/>
-<meta name="twitter:title" content="About"/>
+<meta itemprop="keywords" content="" /><meta name="twitter:card" content="summary"/><meta name="twitter:title" content="About"/>
 <meta name="twitter:description" content="Good code is its own best documentation — Steve McConnell"/>
 
 
@@ -225,7 +225,7 @@ <h1 class="f1">
     <footer class="bg-dark-gray bottom-0 w-100 pa3" role="contentinfo">
   <div class="flex justify-between">
   <a class="f4 fw4 hover-white no-underline white-70 dn dib-ns pv2 ph3" href="https://ivs-kuleuven.github.io/plato-cgse-doc/" >
-    &copy;  The Common-EGSE Documentation 2023 
+    &copy;  The Common-EGSE Documentation 2024 
   </a>
     <div>
 <div class="ananke-socials">

docs/api/egse/aeu/aeu.html

@@ -51,7 +51,7 @@ <h1 class="title">Module <code>egse.aeu.aeu</code></h1>
 from egse.proxy import Proxy
 from egse.resource import get_resource
 from egse.settings import Settings
-from egse.state import GlobalState
+from egse.setup import Setup
 from egse.system import find_class, SignalCatcher
 from egse.zmq_ser import connect_address
 
@@ -842,7 +842,8 @@ <h1 class="title">Module <code>egse.aeu.aeu</code></h1>
     N_CCD_READ_43_75 = &#34;ccdRead43_75.arb&#34;,    # CCD readout for N-CAM (image cycle time: 43.75s)
     N_CCD_READ_50 = &#34;ccdRead50.arb&#34;,          # CCD readout for N-CAM (image cycle time: 50s)
 
-    F_CCD_READ = &#34;FccdRead.arb&#34;,  # CCD readout for F-CAM (fixed image cycle time)
+    F_CCD_READ = &#34;FccdRead.arb&#34;,                        # CCD readout for F-CAM (fixed image cycle time)
+    F_CCD_READ_MIN_POINTS = &#34;FccdRead_min_points.arb&#34;   # Taken from PTO-EST-SC-TN-1563 (v1.0)
 
     # Files modified by KUL to configure Clk_ccdread with short pulses of 150ms
 
@@ -860,7 +861,8 @@ <h1 class="title">Module <code>egse.aeu.aeu</code></h1>
     SVM_SYNC_CCD_READ_43_75 = &#34;HeaterSync_ccdRead43_75.arb&#34;,     # SVM/TCS sync signal (image cycle time: 43.75s)
     SVM_SYNC_CCD_READ_50 = &#34;HeaterSync_ccdRead50.arb&#34;            # SVM/TCS sync signal (image cycle time: 50s)
 
-    SVM_SYNC_F_CAM = &#34;HeaterSync_FccdRead.arb&#34;              # SVM/TCS sync signal (fixed image cycle time)
+    SVM_SYNC_F_CAM = &#34;HeaterSync_FccdRead.arb&#34;                   # SVM/TCS sync signal (fixed image cycle time)
+    SVM_SYNC_F_CAM_MIN_POINTS = &#34;Heater_FccdRead_min_points.arb&#34; # Taken from PTO-EST-SC-TN-1563 (v1.0)
 
 
 class ArbData:
@@ -5233,30 +5235,33 @@ <h1 class="title">Module <code>egse.aeu.aeu</code></h1>
         return True
 
 
-def get_n_cam_cycle_time():
+def get_n_cam_cycle_time(setup: Setup):
     &#34;&#34;&#34; Return the N-CAM cycle time.
 
+    Args:
+        - setup: Setup.
+
     Returns: N-CAM cycle time [s].
     &#34;&#34;&#34;
 
     with AWGProxy(2) as awg2:
 
         identifier = awg2.get_arb1_def()[0][-1]
 
-        awg2_cal = GlobalState.setup.gse.aeu.awg2.calibration
+        awg2_cal = setup.gse.aeu.awg2.calibration
         sync_data_string = awg2_cal.n_cam_sync_data[identifier]
 
         return float(SyncData(sync_data_string).image_cycle_time)
 
 
-def get_f_cam_cycle_time():
+def get_f_cam_cycle_time(setup: Setup):
     &#34;&#34;&#34; Return the F-CAM cycle time.
 
     Returns: F-CAM cycle time [s].
     &#34;&#34;&#34;
 
-    awg2_cal = GlobalState.setup.gse.aeu.awg2.calibration
-    sync_data_string = awg2_cal.n_cam_sync_data[&#34;F&#34;]
+    awg2_cal = setup.gse.aeu.awg2.calibration
+    sync_data_string = awg2_cal.f_cam_sync_data[&#34;F&#34;]
 
     return float(SyncData(sync_data_string).image_cycle_time)</code></pre>
 </details>
@@ -5434,7 +5439,7 @@ <h2 id="args">Args</h2>
 </details>
 </dd>
 <dt id="egse.aeu.aeu.get_f_cam_cycle_time"><code class="name flex">
-<span>def <span class="ident">get_f_cam_cycle_time</span></span>(<span>)</span>
+<span>def <span class="ident">get_f_cam_cycle_time</span></span>(<span>setup: <a title="egse.setup.Setup" href="../setup.html#egse.setup.Setup">Setup</a>)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Return the F-CAM cycle time.</p>
@@ -5443,39 +5448,46 @@ <h2 id="args">Args</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def get_f_cam_cycle_time():
+<pre><code class="python">def get_f_cam_cycle_time(setup: Setup):
     &#34;&#34;&#34; Return the F-CAM cycle time.
 
     Returns: F-CAM cycle time [s].
     &#34;&#34;&#34;
 
-    awg2_cal = GlobalState.setup.gse.aeu.awg2.calibration
-    sync_data_string = awg2_cal.n_cam_sync_data[&#34;F&#34;]
+    awg2_cal = setup.gse.aeu.awg2.calibration
+    sync_data_string = awg2_cal.f_cam_sync_data[&#34;F&#34;]
 
     return float(SyncData(sync_data_string).image_cycle_time)</code></pre>
 </details>
 </dd>
 <dt id="egse.aeu.aeu.get_n_cam_cycle_time"><code class="name flex">
-<span>def <span class="ident">get_n_cam_cycle_time</span></span>(<span>)</span>
+<span>def <span class="ident">get_n_cam_cycle_time</span></span>(<span>setup: <a title="egse.setup.Setup" href="../setup.html#egse.setup.Setup">Setup</a>)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Return the N-CAM cycle time.</p>
-<p>Returns: N-CAM cycle time [s].</p></div>
+<h2 id="args">Args</h2>
+<ul>
+<li>setup: Setup.
+Returns: N-CAM cycle time [s].</li>
+</ul></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def get_n_cam_cycle_time():
+<pre><code class="python">def get_n_cam_cycle_time(setup: Setup):
     &#34;&#34;&#34; Return the N-CAM cycle time.
 
+    Args:
+        - setup: Setup.
+
     Returns: N-CAM cycle time [s].
     &#34;&#34;&#34;
 
     with AWGProxy(2) as awg2:
 
         identifier = awg2.get_arb1_def()[0][-1]
 
-        awg2_cal = GlobalState.setup.gse.aeu.awg2.calibration
+        awg2_cal = setup.gse.aeu.awg2.calibration
         sync_data_string = awg2_cal.n_cam_sync_data[identifier]
 
         return float(SyncData(sync_data_string).image_cycle_time)</code></pre>
@@ -10211,7 +10223,8 @@ <h2 id="args">Args</h2>
     N_CCD_READ_43_75 = &#34;ccdRead43_75.arb&#34;,    # CCD readout for N-CAM (image cycle time: 43.75s)
     N_CCD_READ_50 = &#34;ccdRead50.arb&#34;,          # CCD readout for N-CAM (image cycle time: 50s)
 
-    F_CCD_READ = &#34;FccdRead.arb&#34;,  # CCD readout for F-CAM (fixed image cycle time)
+    F_CCD_READ = &#34;FccdRead.arb&#34;,                        # CCD readout for F-CAM (fixed image cycle time)
+    F_CCD_READ_MIN_POINTS = &#34;FccdRead_min_points.arb&#34;   # Taken from PTO-EST-SC-TN-1563 (v1.0)
 
     # Files modified by KUL to configure Clk_ccdread with short pulses of 150ms
 
@@ -10229,7 +10242,8 @@ <h2 id="args">Args</h2>
     SVM_SYNC_CCD_READ_43_75 = &#34;HeaterSync_ccdRead43_75.arb&#34;,     # SVM/TCS sync signal (image cycle time: 43.75s)
     SVM_SYNC_CCD_READ_50 = &#34;HeaterSync_ccdRead50.arb&#34;            # SVM/TCS sync signal (image cycle time: 50s)
 
-    SVM_SYNC_F_CAM = &#34;HeaterSync_FccdRead.arb&#34;              # SVM/TCS sync signal (fixed image cycle time)</code></pre>
+    SVM_SYNC_F_CAM = &#34;HeaterSync_FccdRead.arb&#34;                   # SVM/TCS sync signal (fixed image cycle time)
+    SVM_SYNC_F_CAM_MIN_POINTS = &#34;Heater_FccdRead_min_points.arb&#34; # Taken from PTO-EST-SC-TN-1563 (v1.0)</code></pre>
 </details>
 <h3>Ancestors</h3>
 <ul class="hlist">
@@ -10242,6 +10256,10 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="egse.aeu.aeu.ArbDataFile.F_CCD_READ_MIN_POINTS"><code class="name">var <span class="ident">F_CCD_READ_MIN_POINTS</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="egse.aeu.aeu.ArbDataFile.N_CCD_READ_25"><code class="name">var <span class="ident">N_CCD_READ_25</span></code></dt>
 <dd>
 <div class="desc"></div>
@@ -10306,6 +10324,10 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="egse.aeu.aeu.ArbDataFile.SVM_SYNC_F_CAM_MIN_POINTS"><code class="name">var <span class="ident">SVM_SYNC_F_CAM_MIN_POINTS</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 </dl>
 </dd>
 <dt id="egse.aeu.aeu.CRIOController"><code class="flex name class">
@@ -17408,6 +17430,7 @@ <h4><code><a title="egse.aeu.aeu.ArbData" href="#egse.aeu.aeu.ArbData">ArbData</
 <h4><code><a title="egse.aeu.aeu.ArbDataFile" href="#egse.aeu.aeu.ArbDataFile">ArbDataFile</a></code></h4>
 <ul class="">
 <li><code><a title="egse.aeu.aeu.ArbDataFile.F_CCD_READ" href="#egse.aeu.aeu.ArbDataFile.F_CCD_READ">F_CCD_READ</a></code></li>
+<li><code><a title="egse.aeu.aeu.ArbDataFile.F_CCD_READ_MIN_POINTS" href="#egse.aeu.aeu.ArbDataFile.F_CCD_READ_MIN_POINTS">F_CCD_READ_MIN_POINTS</a></code></li>
 <li><code><a title="egse.aeu.aeu.ArbDataFile.N_CCD_READ_25" href="#egse.aeu.aeu.ArbDataFile.N_CCD_READ_25">N_CCD_READ_25</a></code></li>
 <li><code><a title="egse.aeu.aeu.ArbDataFile.N_CCD_READ_25_150MS" href="#egse.aeu.aeu.ArbDataFile.N_CCD_READ_25_150MS">N_CCD_READ_25_150MS</a></code></li>
 <li><code><a title="egse.aeu.aeu.ArbDataFile.N_CCD_READ_31_25" href="#egse.aeu.aeu.ArbDataFile.N_CCD_READ_31_25">N_CCD_READ_31_25</a></code></li>
@@ -17424,6 +17447,7 @@ <h4><code><a title="egse.aeu.aeu.ArbDataFile" href="#egse.aeu.aeu.ArbDataFile">A
 <li><code><a title="egse.aeu.aeu.ArbDataFile.SVM_SYNC_CCD_READ_43_75" href="#egse.aeu.aeu.ArbDataFile.SVM_SYNC_CCD_READ_43_75">SVM_SYNC_CCD_READ_43_75</a></code></li>
 <li><code><a title="egse.aeu.aeu.ArbDataFile.SVM_SYNC_CCD_READ_50" href="#egse.aeu.aeu.ArbDataFile.SVM_SYNC_CCD_READ_50">SVM_SYNC_CCD_READ_50</a></code></li>
 <li><code><a title="egse.aeu.aeu.ArbDataFile.SVM_SYNC_F_CAM" href="#egse.aeu.aeu.ArbDataFile.SVM_SYNC_F_CAM">SVM_SYNC_F_CAM</a></code></li>
+<li><code><a title="egse.aeu.aeu.ArbDataFile.SVM_SYNC_F_CAM_MIN_POINTS" href="#egse.aeu.aeu.ArbDataFile.SVM_SYNC_F_CAM_MIN_POINTS">SVM_SYNC_F_CAM_MIN_POINTS</a></code></li>
 </ul>
 </li>
 <li>