Generate API documentation c2c4f89

LIVVkit · May 2, 2024 · 69bb96a · 69bb96a
1 parent 0eef31b
commit 69bb96a
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 42 deletions.
diff --git a/classIndex.html b/classIndex.html
@@ -85,7 +85,7 @@ <h1>Class Hierarchy</h1>
     <div class="container">
       <a href="index.html">API Documentation</a> for <a href="https://github.com/LIVVkit/modelmimic" class="projecthome">ModelMimic</a>,
     generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-      23.9.1 at 2024-05-02 15:39:16.
+      23.9.1 at 2024-05-02 16:24:45.
     </div>
 
     <script src="ajax.js" type="text/javascript"></script>

diff --git a/index.html b/index.html
@@ -248,7 +248,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -309,7 +309,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
   <div class="functionHeader">
 
     <span class="py-defname">__version_info__</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a>[<wbr></wbr><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a>, <wbr></wbr><span class="rst-variable-ellipsis">...</span>]</code> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py#L1">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py#L1">
 
       (source)
     </a>
@@ -336,7 +336,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
   <div class="functionHeader">
 
     <span class="py-defname">__version__</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py#L2">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py#L2">
 
       (source)
     </a>
@@ -363,7 +363,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
   <div class="functionHeader">
 
     <span class="py-defname">logo</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py#L3">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py#L3">
 
       (source)
     </a>
@@ -391,7 +391,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
     <div class="container">
       <a href="index.html">API Documentation</a> for <a href="https://github.com/LIVVkit/modelmimic" class="projecthome">ModelMimic</a>,
     generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-      23.9.1 at 2024-05-02 15:39:16.
+      23.9.1 at 2024-05-02 16:24:45.
     </div>
 
     <script src="ajax.js" type="text/javascript"></script>

diff --git a/modelmimic.html b/modelmimic.html
@@ -248,7 +248,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -309,7 +309,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
   <div class="functionHeader">
 
     <span class="py-defname">__version_info__</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a>[<wbr></wbr><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a>, <wbr></wbr><span class="rst-variable-ellipsis">...</span>]</code> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py#L1">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py#L1">
 
       (source)
     </a>
@@ -336,7 +336,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
   <div class="functionHeader">
 
     <span class="py-defname">__version__</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py#L2">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py#L2">
 
       (source)
     </a>
@@ -363,7 +363,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
   <div class="functionHeader">
 
     <span class="py-defname">logo</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/__init__.py#L3">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/__init__.py#L3">
 
       (source)
     </a>
@@ -391,7 +391,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">model
     <div class="container">
       <a href="index.html">API Documentation</a> for <a href="https://github.com/LIVVkit/modelmimic" class="projecthome">ModelMimic</a>,
     generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-      23.9.1 at 2024-05-02 15:39:16.
+      23.9.1 at 2024-05-02 16:24:45.
     </div>
 
     <script src="ajax.js" type="text/javascript"></script>

diff --git a/modelmimic.mimic.MimicModelRun.html b/modelmimic.mimic.MimicModelRun.html
@@ -453,7 +453,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
         </div>
 
         <div class="extrasDocstring">
-          <p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">MimicModelRun</span>: <a href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L199" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="modelmimic.mimic.MimicModelRun.__init__">MimicModelRun(name, variables, ntimes, size, ...)</a></code></p>
+          <p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">MimicModelRun</span>: <a href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L199" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="modelmimic.mimic.MimicModelRun.__init__">MimicModelRun(name, variables, ntimes, size, ...)</a></code></p>
           <p><a href="classIndex.html#modelmimic.mimic.MimicModelRun">View In Hierarchy</a></p>
         </div>
 
@@ -556,7 +556,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
 
 
     <span class="py-keyword">def</span> <span class="py-defname">__init__</span><span class="function-signature">(self, name: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>, variables: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a></code>, ntimes: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 12, size: <code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a></code> = (<wbr></wbr>5, <wbr></wbr>10), ninst: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 1, dims: <code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a></code> = (<wbr></wbr><span class="rst-variable-quote">'</span><span class="rst-variable-string">nlev</span><span class="rst-variable-quote">'</span>, <wbr></wbr><span class="rst-variable-quote">'</span><span class="rst-variable-string">ncol</span><span class="rst-variable-quote">'</span>))</span>:
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L200">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L200">
 
       (source)
     </a>
@@ -583,7 +583,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_file_times</span><span class="function-signature">(self, sim_start: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> = <span class="rst-variable-quote">'</span><span class="rst-variable-string">0001-01-01</span><span class="rst-variable-quote">'</span>, timestep: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> = <span class="rst-variable-quote">'</span><span class="rst-variable-string">month</span><span class="rst-variable-quote">'</span>, step_mult: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 1)</span>:
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L294">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L294">
 
       (source)
     </a>
@@ -610,7 +610,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
 
 
     <span class="py-keyword">def</span> <span class="py-defname">make_ensemble</span><span class="function-signature">(self, popmean: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0.0, popvar: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 1e-05, seed: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = <a href="https://docs.python.org/3/library/constants.html#False" class="intersphinx-link">False</a>)</span>:
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L249">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L249">
 
       (source)
     </a>
@@ -638,7 +638,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
 
 
     <span class="py-keyword">def</span> <span class="py-defname">write_to_nc</span><span class="function-signature">(self, out_path: <code><a href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" class="intersphinx-link">Path</a></code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, sim_start: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> = <span class="rst-variable-quote">'</span><span class="rst-variable-string">0001-01-01</span><span class="rst-variable-quote">'</span>, timestep: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> = <span class="rst-variable-quote">'</span><span class="rst-variable-string">month</span><span class="rst-variable-quote">'</span>, step_mult: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 1, hist_file_pattern: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> = <span class="rst-variable-quote">'</span><span class="rst-variable-string">eam_{inst:04d}.h0.{time}</span><span class="rst-variable-quote">'</span>, file_suffix: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>)</span>:
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L326">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L326">
 
       (source)
     </a>
@@ -664,7 +664,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">axes</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L241">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L241">
 
       (source)
     </a>
@@ -691,7 +691,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">base_data</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#dict" class="intersphinx-link">dict</a></code> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L233">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L233">
 
       (source)
     </a>
@@ -718,7 +718,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">dims</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L229">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L229">
 
       (source)
     </a>
@@ -745,7 +745,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">ens_data</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L292">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L292">
 
       (source)
     </a>
@@ -772,7 +772,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">name</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L224">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L224">
 
       (source)
     </a>
@@ -799,7 +799,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">ninst</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L228">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L228">
 
       (source)
     </a>
@@ -826,7 +826,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">ntimes</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L226">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L226">
 
       (source)
     </a>
@@ -853,7 +853,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">size</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L227">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L227">
 
       (source)
     </a>
@@ -880,7 +880,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
   <div class="functionHeader">
 
     <span class="py-defname">vars</span> =
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L225">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L225">
 
       (source)
     </a>
@@ -908,7 +908,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
 
 
     <span class="py-keyword">def</span> <span class="py-defname">__repr__</span><span class="function-signature">(self)</span>:
-    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/f4e406db68c7d4fcd8413e69c938341148db672e/modelmimic/mimic.py#L243">
+    <a class="sourceLink" href="https://github.com/LIVVkit/modelmimic/tree/c2c4f8974233dea110dff57e6e557a4b1ae6b99b/modelmimic/mimic.py#L243">
 
       (source)
     </a>
@@ -935,7 +935,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">modelmi
     <div class="container">
       <a href="index.html">API Documentation</a> for <a href="https://github.com/LIVVkit/modelmimic" class="projecthome">ModelMimic</a>,
     generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-      23.9.1 at 2024-05-02 15:39:16.
+      23.9.1 at 2024-05-02 16:24:45.
     </div>
 
     <script src="ajax.js" type="text/javascript"></script>