deploy: b224469

dgbowl · Nov 18, 2024 · a0cad5b · a0cad5b
1 parent 13b21ee
commit a0cad5b
Show file tree

Hide file tree

Showing 17 changed files with 408 additions and 220 deletions.
diff --git a/main/_sources/quickstart.rst.txt b/main/_sources/quickstart.rst.txt
@@ -21,12 +21,10 @@ The easiest way to do create this file is using the provided ``tomato init`` com
 
 .. code-block::
    :linenos:
-   :emphasize-lines: 3
+   :emphasize-lines: 2
 
     kraus@dorje:/home/kraus/$ tomato init
-    data: null
-    msg: wrote default settings into /home/kraus/.config/tomato/1.0a1/settings.toml
-    success: true
+    Success: wrote default settings into /home/kraus/.config/tomato/1.0a1/settings.toml
 
 Where *appdir* is ``/home/kraus/.config/tomato/1.0a1/``. The *appdir* can be specified
 using the ``--appdir`` argument to **tomato**.
@@ -206,12 +204,12 @@ The ``devices`` section of the default *devices file* is shown below:
       - name: dev-counter
         driver: "example_counter"
         address: "example-addr"
-        channels: [1]
+        channels: ["1"]
         pollrate: 1
 
 Here, we define a single device using the :mod:`~tomato.drivers.example_counter` driver.
 The definition includes the ``address`` of the device (:class:`str` type) as well as an
-enumeration of individually-addressable channels the device has (:class:`list[int]`).
+enumeration of individually-addressable channels the device has (:class:`list[str]`).
 
 For example, the devices shown in the :ref:`concepts flowchart <concepts>` above would
 be defined as:
@@ -223,17 +221,17 @@ be defined as:
       - name: device 1
         driver: "driver 123"
         address: "192.168.1.1"
-        channels: [1, 2, 3]
+        channels: ["1", "2", "3"]
         pollrate: 1
       - name: device a
         driver: "driver abc"
         address: "COM1"
-        channels: [100]
+        channels: ["100"]
         pollrate: 5
       - name: device b
         driver: "driver abc"
         address: "COM2"
-        channels: [100]
+        channels: ["100"]
         pollrate: 5
 
 
@@ -256,7 +254,7 @@ The default ``pipelines`` section looks as follows:
         components:
           - role: counter
             device: dev-counter
-            channel: 1
+            channel: "1"
 
 Here, a single *pipeline* called ``pip-counter`` is defined to contain the one available
 channel of the ``dev-counter`` device (defined on line 5) shown further above. For multi
@@ -290,23 +288,23 @@ above can be defined as:
         components:
           - role: dev 123
             device: device 1
-            channel: 1
+            channel: "1"
           - role: dev abc
             device: device a
-            channel: 100
+            channel: "100"
       - name: pipeline b2
         components:
           - role: dev 123
             device: device 1
-            channel: 2
+            channel: "2"
           - role: dev abc
             device: device b
-            channel: 100
+            channel: "100"
       - name: pipeline 3
         components:
           - role: dev 123
             device: device 1
-            channel: 3
+            channel: "3"
 
 .. _payfile:
 

diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.0rc2.dev2',
+    VERSION: '1.0rc2.dev3',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/main/apidoc/tomato.daemon.html b/main/apidoc/tomato.daemon.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tomato.daemon package &mdash; tomato 1.0rc2.dev2 documentation</title>
+  <title>tomato.daemon package &mdash; tomato 1.0rc2.dev3 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/autodoc_pydantic.css" type="text/css" />
@@ -16,7 +16,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=9916553d"></script>
+        <script src="../_static/documentation_options.js?v=3d6ed124"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
@@ -39,7 +39,7 @@
               <img src="../_static/tomato.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                1.0rc2.dev2
+                1.0rc2.dev3
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -304,7 +304,7 @@ <h3><strong>tomato.daemon.cmd</strong>: command parsing for tomato daemon<a clas
 </section>
 <dl class="py function">
 <dt class="sig sig-object py" id="tomato.daemon.job.find_matching_pipelines">
-<span class="sig-prename descclassname"><span class="pre">tomato.daemon.job.</span></span><span class="sig-name descname"><span class="pre">find_matching_pipelines</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pips</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="tomato.html#tomato.models.Pipeline" title="tomato.models.Pipeline"><span class="pre">Pipeline</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="tomato.html#tomato.models.Component" title="tomato.models.Component"><span class="pre">Component</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v119.dev1)"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="tomato.html#tomato.models.Pipeline" title="tomato.models.Pipeline"><span class="pre">Pipeline</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#tomato.daemon.job.find_matching_pipelines" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">tomato.daemon.job.</span></span><span class="sig-name descname"><span class="pre">find_matching_pipelines</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pips</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="tomato.html#tomato.models.Pipeline" title="tomato.models.Pipeline"><span class="pre">Pipeline</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="tomato.html#tomato.models.Component" title="tomato.models.Component"><span class="pre">Component</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v120.dev1)"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="tomato.html#tomato.models.Pipeline" title="tomato.models.Pipeline"><span class="pre">Pipeline</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#tomato.daemon.job.find_matching_pipelines" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
@@ -414,7 +414,7 @@ <h3><strong>tomato.daemon.cmd</strong>: command parsing for tomato daemon<a clas
   <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
     <span class="rst-current-version" data-toggle="rst-current-version">
       <span class="fa fa-book"> Other Versions</span>
-      v: 1.0rc2.dev2
+      v: 1.0rc2.dev3
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions"> 

diff --git a/main/apidoc/tomato.driverinterface_1_0.html b/main/apidoc/tomato.driverinterface_1_0.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>tomato.driverinterface_1_0 package &mdash; tomato 1.0rc2.dev2 documentation</title>
+  <title>tomato.driverinterface_1_0 package &mdash; tomato 1.0rc2.dev3 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/autodoc_pydantic.css" type="text/css" />
@@ -16,7 +16,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=9916553d"></script>
+        <script src="../_static/documentation_options.js?v=3d6ed124"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
@@ -39,7 +39,7 @@
               <img src="../_static/tomato.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                1.0rc2.dev2
+                1.0rc2.dev3
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -297,14 +297,14 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="tomato.driverinterface_1_0.ModelInterface.DeviceManager.prepare_task">
-<span class="sig-name descname"><span class="pre">prepare_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v119.dev1)"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tomato.driverinterface_1_0.ModelInterface.DeviceManager.prepare_task" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">prepare_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v120.dev1)"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tomato.driverinterface_1_0.ModelInterface.DeviceManager.prepare_task" title="Link to this definition"></a></dt>
 <dd><p>Given a <code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code>, prepare this component for execution by settin all
 <code class="xref py py-class docutils literal notranslate"><span class="pre">Attrs</span></code> as specified in the <cite>task.technique_params</cite> dictionary.</p>
 </dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="tomato.driverinterface_1_0.ModelInterface.DeviceManager.do_task">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">do_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v119.dev1)"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tomato.driverinterface_1_0.ModelInterface.DeviceManager.do_task" title="Link to this definition"></a></dt>
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">do_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v120.dev1)"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tomato.driverinterface_1_0.ModelInterface.DeviceManager.do_task" title="Link to this definition"></a></dt>
 <dd><p>Periodically called task execution function.</p>
 <p>This function is responsible for updating <code class="xref py py-obj docutils literal notranslate"><span class="pre">self.data</span></code> with new data, i.e.
 performing the measurement. It should also update the values of all
@@ -441,7 +441,7 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="tomato.driverinterface_1_0.ModelInterface.task_start">
-<span class="sig-name descname"><span class="pre">task_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v119.dev1)"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="tomato.html#tomato.models.Reply" title="tomato.models.Reply"><span class="pre">Reply</span></a></span></span><a class="headerlink" href="#tomato.driverinterface_1_0.ModelInterface.task_start" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">task_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://dgbowl.github.io/dgbowl-schemas/main/apidoc/dgbowl_schemas.tomato.payload_1_0.html#dgbowl_schemas.tomato.payload_1_0.task.Task" title="(in dgbowl-schemas v120.dev1)"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="tomato.html#tomato.models.Reply" title="tomato.models.Reply"><span class="pre">Reply</span></a></span></span><a class="headerlink" href="#tomato.driverinterface_1_0.ModelInterface.task_start" title="Link to this definition"></a></dt>
 <dd><p>Submit a <code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code> onto the specified device component.</p>
 <p>Pushes the supplied <code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code> into the <code class="xref py py-class docutils literal notranslate"><span class="pre">Queue</span></code> of the component,
 then starts the worker thread. Checks that the <code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code> is among the
@@ -529,7 +529,7 @@
   <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
     <span class="rst-current-version" data-toggle="rst-current-version">
       <span class="fa fa-book"> Other Versions</span>
-      v: 1.0rc2.dev2
+      v: 1.0rc2.dev3
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">