adding HTML documentation for publication

CHANGELOG.md

@@ -1,4 +1,16 @@
 
+## releasing 1.3.0 (2024-07-22)
+### Overview
+This version added two universal runtime parameters that make some aspects of the runtime environment are recorded in the views' metadata. 
+
+
+### Additions
+- `hwFetch` universal parameter will record CPU architecture and CUDA devices in `view.metadata.appRunningHardware` 
+- `runningTime` universal parameter will record app's running time in `view.metadata.appRunningTime`
+- See https://github.com/clamsproject/clams-python/issues/236 for rationale behind 
+
+
+
 ## releasing 1.2.6 (2024-07-15)
 ### Overview
 Patch release to update mmif SDK version, and minor improvements

docs/_sources/appmetadata.rst.txt

@@ -91,7 +91,7 @@ input specification can be as simple as the following:
       # and more app metadata fields, 
     }
     
-In the above example, the developer is declaring the app is expecting ``Token``annotation objects, with a ``posTagSet`` 
+In the above example, the developer is declaring the app is expecting ``Token`` annotation objects, with a ``posTagSet`` 
 property of which value is the URL of the Penn Treebank POS tag set, *verbatim*, in the input MMIF, and all other 
 existing annotation types in the input MMIF will be ignored during processing. There are some *grammar* of how this 
 ``input`` list can be written. 

docs/_sources/autodoc/clams.appmetadata.rst.txt

@@ -6,3 +6,15 @@ Module contents
 
 .. autoclass:: clams.appmetadata.AppMetadata
    :members:
+
+.. autoclass:: clams.appmetadata.Input
+   :members:
+   :inherited-members:
+
+.. autoclass:: clams.appmetadata.Output
+   :members:
+   :inherited-members:
+
+.. autoclass:: clams.appmetadata.RuntimeParameter
+   :members:
+   :inherited-members:

docs/appdirectory.html

@@ -37,7 +37,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/appmetadata.html

@@ -37,7 +37,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -182,7 +182,7 @@ <h5>Simple case - using types as defined in the vocabularies<a class="headerlink
 <span class="p">}</span>
 </pre></div>
 </div>
-<p>In the above example, the developer is declaring the app is expecting <code class="docutils literal notranslate"><span class="pre">Token``annotation</span> <span class="pre">objects,</span> <span class="pre">with</span> <span class="pre">a</span> <span class="pre">``posTagSet</span></code>
+<p>In the above example, the developer is declaring the app is expecting <code class="docutils literal notranslate"><span class="pre">Token</span></code> annotation objects, with a <code class="docutils literal notranslate"><span class="pre">posTagSet</span></code>
 property of which value is the URL of the Penn Treebank POS tag set, <em>verbatim</em>, in the input MMIF, and all other
 existing annotation types in the input MMIF will be ignored during processing. There are some <em>grammar</em> of how this
 <code class="docutils literal notranslate"><span class="pre">input</span></code> list can be written.</p>

docs/autodoc/clams.app.html

@@ -37,7 +37,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -296,7 +296,7 @@ <h1>clams.app package<a class="headerlink" href="#clams-app-package" title="Perm
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="clams.app.ClamsApp.universal_parameters">
-<span class="sig-name descname"><span class="pre">universal_parameters</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[{'name':</span> <span class="pre">'pretty',</span> <span class="pre">'type':</span> <span class="pre">'boolean',</span> <span class="pre">'choices':</span> <span class="pre">None,</span> <span class="pre">'default':</span> <span class="pre">False,</span> <span class="pre">'multivalued':</span> <span class="pre">False,</span> <span class="pre">'description':</span> <span class="pre">'The</span> <span class="pre">JSON</span> <span class="pre">body</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">HTTP</span> <span class="pre">response</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">re-formatted</span> <span class="pre">with</span> <span class="pre">2-space</span> <span class="pre">indentation'}]</span></em><a class="reference external" href="https://github.com/clamsproject/clams-python/tree/main/clams/app/__init__.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#clams.app.ClamsApp.universal_parameters" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">universal_parameters</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[{'name':</span> <span class="pre">'pretty',</span> <span class="pre">'type':</span> <span class="pre">'boolean',</span> <span class="pre">'choices':</span> <span class="pre">None,</span> <span class="pre">'default':</span> <span class="pre">False,</span> <span class="pre">'multivalued':</span> <span class="pre">False,</span> <span class="pre">'description':</span> <span class="pre">'The</span> <span class="pre">JSON</span> <span class="pre">body</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">HTTP</span> <span class="pre">response</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">re-formatted</span> <span class="pre">with</span> <span class="pre">2-space</span> <span class="pre">indentation'},</span> <span class="pre">{'name':</span> <span class="pre">'runningTime',</span> <span class="pre">'type':</span> <span class="pre">'boolean',</span> <span class="pre">'choices':</span> <span class="pre">None,</span> <span class="pre">'default':</span> <span class="pre">False,</span> <span class="pre">'multivalued':</span> <span class="pre">False,</span> <span class="pre">'description':</span> <span class="pre">'The</span> <span class="pre">running</span> <span class="pre">time</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">app</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">recorded</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">view</span> <span class="pre">metadata'},</span> <span class="pre">{'name':</span> <span class="pre">'hwFetch',</span> <span class="pre">'type':</span> <span class="pre">'boolean',</span> <span class="pre">'choices':</span> <span class="pre">None,</span> <span class="pre">'default':</span> <span class="pre">False,</span> <span class="pre">'multivalued':</span> <span class="pre">False,</span> <span class="pre">'description':</span> <span class="pre">'The</span> <span class="pre">hardware</span> <span class="pre">information</span> <span class="pre">(architecture,</span> <span class="pre">GPU</span> <span class="pre">and</span> <span class="pre">vRAM)</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">recorded</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">view</span> <span class="pre">metadata'}]</span></em><a class="reference external" href="https://github.com/clamsproject/clams-python/tree/main/clams/app/__init__.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#clams.app.ClamsApp.universal_parameters" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py method">

docs/autodoc/clams.restify.html

@@ -37,7 +37,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

docs/autodoc/clams.source.html

@@ -37,7 +37,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

docs/clamsapp.html

@@ -35,7 +35,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/cli.html

@@ -37,7 +37,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/genindex.html

@@ -34,7 +34,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -89,8 +89,10 @@ <h1 id="index">Index</h1>
  <a href="#_"><strong>_</strong></a>
  | <a href="#A"><strong>A</strong></a>
  | <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
+ | <a href="#I"><strong>I</strong></a>
  | <a href="#J"><strong>J</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#O"><strong>O</strong></a>
@@ -128,16 +130,22 @@ <h2 id="_">_</h2>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Input.add_description">add_description() (clams.appmetadata.Input method)</a>
+
+      <ul>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Output.add_description">(clams.appmetadata.Output method)</a>
+</li>
+      </ul></li>
       <li><a href="autodoc/clams.source.html#clams.source.WorkflowSource.add_document">add_document() (clams.source.WorkflowSource method)</a>
 </li>
       <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.AppMetadata.add_input">add_input() (clams.appmetadata.AppMetadata method)</a>
 </li>
       <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.AppMetadata.add_more">add_more() (clams.appmetadata.AppMetadata method)</a>
-</li>
-      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.AppMetadata.add_output">add_output() (clams.appmetadata.AppMetadata method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.AppMetadata.add_output">add_output() (clams.appmetadata.AppMetadata method)</a>
+</li>
       <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.AppMetadata.add_parameter">add_parameter() (clams.appmetadata.AppMetadata method)</a>
 </li>
       <li><a href="autodoc/clams.app.html#clams.app.ClamsApp.annotate">annotate() (clams.app.ClamsApp method)</a>
@@ -168,19 +176,49 @@ <h2 id="C">C</h2>
         <li><a href="autodoc/clams.restify.html#module-clams.restify">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     clams.source
 
       <ul>
         <li><a href="autodoc/clams.source.html#module-clams.source">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autodoc/clams.app.html#clams.app.ClamsApp">ClamsApp (class in clams.app)</a>
 </li>
       <li><a href="autodoc/clams.restify.html#clams.restify.ClamsHTTPApi">ClamsHTTPApi (class in clams.restify)</a>
 </li>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Input.construct">construct() (clams.appmetadata.Input class method)</a>
+
+      <ul>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Output.construct">(clams.appmetadata.Output class method)</a>
+</li>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.RuntimeParameter.construct">(clams.appmetadata.RuntimeParameter class method)</a>
+</li>
+      </ul></li>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Input.copy">copy() (clams.appmetadata.Input method)</a>
+
+      <ul>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Output.copy">(clams.appmetadata.Output method)</a>
+</li>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.RuntimeParameter.copy">(clams.appmetadata.RuntimeParameter method)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Input.dict">dict() (clams.appmetadata.Input method)</a>
+
+      <ul>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Output.dict">(clams.appmetadata.Output method)</a>
+</li>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.RuntimeParameter.dict">(clams.appmetadata.RuntimeParameter method)</a>
+</li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
@@ -204,8 +242,26 @@ <h2 id="G">G</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="I">I</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Input">Input (class in clams.appmetadata)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="J">J</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Input.json">json() (clams.appmetadata.Input method)</a>
+
+      <ul>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Output.json">(clams.appmetadata.Output method)</a>
+</li>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.RuntimeParameter.json">(clams.appmetadata.RuntimeParameter method)</a>
+</li>
+      </ul></li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autodoc/clams.restify.html#clams.restify.ClamsHTTPApi.json_to_response">json_to_response() (clams.restify.ClamsHTTPApi static method)</a>
 </li>
@@ -237,6 +293,10 @@ <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autodoc/clams.app.html#clams.app.ClamsApp.open_document_location">open_document_location() (clams.app.ClamsApp static method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Output">Output (class in clams.appmetadata)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -262,11 +322,13 @@ <h2 id="R">R</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autodoc/clams.app.html#clams.app.ClamsApp.record_error">record_error() (clams.app.ClamsApp method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autodoc/clams.restify.html#clams.restify.Restifier">Restifier (class in clams.restify)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autodoc/clams.restify.html#clams.restify.Restifier.run">run() (clams.restify.Restifier method)</a>
+</li>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.RuntimeParameter">RuntimeParameter (class in clams.appmetadata)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -300,6 +362,14 @@ <h2 id="U">U</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autodoc/clams.app.html#clams.app.ClamsApp.universal_parameters">universal_parameters (clams.app.ClamsApp attribute)</a>
 </li>
+      <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Input.update_forward_refs">update_forward_refs() (clams.appmetadata.Input class method)</a>
+
+      <ul>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.Output.update_forward_refs">(clams.appmetadata.Output class method)</a>
+</li>
+        <li><a href="autodoc/clams.appmetadata.html#clams.appmetadata.RuntimeParameter.update_forward_refs">(clams.appmetadata.RuntimeParameter class method)</a>
+</li>
+      </ul></li>
   </ul></td>
 </tr></table>
 

docs/index.html

@@ -36,7 +36,7 @@
             clams-python
           </a>
               <div class="version">
-                1.2.6
+                1.3.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">