Update main to output generated at 10f29e7

gwforg · Sep 20, 2023 · 56b76de · 56b76de
1 parent bb298c2
commit 56b76de
Show file tree

Hide file tree

Showing 28 changed files with 467 additions and 360 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/reference/api.doctree b/.doctrees/reference/api.doctree
diff --git a/_modules/gwf/backends/base/index.html b/_modules/gwf/backends/base/index.html
@@ -1,12 +1,12 @@
 <!doctype html>
-<html class="no-js" lang="en">
+<html class="no-js" lang="en" data-content_root="../../../../">
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../../genindex/" /><link rel="search" title="Search" href="../../../../search/" />
 
-    <!-- Generated with Sphinx 7.1.1 and Furo 2023.07.26 -->
+    <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>gwf.backends.base - gwf 2.0.2 documentation</title>
-      <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b849a4e9" />
+      <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=649a27d8" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../../../_static/styles/furo-extensions.css?v=36a5483c" />
 
@@ -219,7 +219,9 @@ <h1>Source code for gwf.backends.base</h1><div class="highlight"><pre>
 <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
 
 
-<div class="viewcode-block" id="BackendStatus"><a class="viewcode-back" href="../../../../reference/api/#gwf.backends.BackendStatus">[docs]</a><span class="k">class</span> <span class="nc">BackendStatus</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
+<div class="viewcode-block" id="BackendStatus">
+<a class="viewcode-back" href="../../../../reference/api/#gwf.backends.BackendStatus">[docs]</a>
+<span class="k">class</span> <span class="nc">BackendStatus</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;BackendStatus of a target.</span>
 
 <span class="sd">    A target is unknown to the backend if it has not been submitted or the</span>
@@ -239,7 +241,10 @@ <h1>Source code for gwf.backends.base</h1><div class="highlight"><pre>
     <span class="n">CANCELLED</span> <span class="o">=</span> <span class="mi">5</span></div>
 
 
-<div class="viewcode-block" id="guess_backend"><a class="viewcode-back" href="../../../../reference/api/#gwf.backends.guess_backend">[docs]</a><span class="k">def</span> <span class="nf">guess_backend</span><span class="p">():</span>
+
+<div class="viewcode-block" id="guess_backend">
+<a class="viewcode-back" href="../../../../reference/api/#gwf.backends.guess_backend">[docs]</a>
+<span class="k">def</span> <span class="nf">guess_backend</span><span class="p">():</span>
     <span class="n">max_score</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1000</span>
     <span class="n">chosen_backend</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="k">for</span> <span class="n">backend_name</span><span class="p">,</span> <span class="p">(</span><span class="n">_</span><span class="p">,</span> <span class="n">score</span><span class="p">)</span> <span class="ow">in</span> <span class="n">discover_backends</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
@@ -249,16 +254,25 @@ <h1>Source code for gwf.backends.base</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">max_score</span><span class="p">,</span> <span class="n">chosen_backend</span></div>
 
 
-<div class="viewcode-block" id="discover_backends"><a class="viewcode-back" href="../../../../reference/api/#gwf.backends.discover_backends">[docs]</a><span class="k">def</span> <span class="nf">discover_backends</span><span class="p">():</span>
+
+<div class="viewcode-block" id="discover_backends">
+<a class="viewcode-back" href="../../../../reference/api/#gwf.backends.discover_backends">[docs]</a>
+<span class="k">def</span> <span class="nf">discover_backends</span><span class="p">():</span>
     <span class="k">return</span> <span class="p">{</span><span class="n">ep</span><span class="o">.</span><span class="n">name</span><span class="p">:</span> <span class="n">ep</span><span class="o">.</span><span class="n">load</span><span class="p">()</span> <span class="k">for</span> <span class="n">ep</span> <span class="ow">in</span> <span class="n">entry_points</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="s2">&quot;gwf.backends&quot;</span><span class="p">)}</span></div>
 
 
-<div class="viewcode-block" id="list_backends"><a class="viewcode-back" href="../../../../reference/api/#gwf.backends.list_backends">[docs]</a><span class="k">def</span> <span class="nf">list_backends</span><span class="p">():</span>
+
+<div class="viewcode-block" id="list_backends">
+<a class="viewcode-back" href="../../../../reference/api/#gwf.backends.list_backends">[docs]</a>
+<span class="k">def</span> <span class="nf">list_backends</span><span class="p">():</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the names of all registered backends.&quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="nb">set</span><span class="p">(</span><span class="n">discover_backends</span><span class="p">()</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span></div>
 
 
-<div class="viewcode-block" id="create_backend"><a class="viewcode-back" href="../../../../reference/api/#gwf.backends.create_backend">[docs]</a><span class="k">def</span> <span class="nf">create_backend</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">working_dir</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
+
+<div class="viewcode-block" id="create_backend">
+<a class="viewcode-back" href="../../../../reference/api/#gwf.backends.create_backend">[docs]</a>
+<span class="k">def</span> <span class="nf">create_backend</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">working_dir</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return backend class for the backend given by `name`.</span>
 
 <span class="sd">    Returns the backend class registered with `name`. Note that the *class*</span>
@@ -274,6 +288,7 @@ <h1>Source code for gwf.backends.base</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">backend_cls</span><span class="p">(</span><span class="n">working_dir</span><span class="o">=</span><span class="n">working_dir</span><span class="p">,</span> <span class="o">**</span><span class="n">backend_args</span><span class="p">)</span></div>
 
 
+
 <span class="nd">@attrs</span><span class="o">.</span><span class="n">define</span><span class="p">()</span>
 <span class="k">class</span> <span class="nc">TrackingBackend</span><span class="p">:</span>
     <span class="n">working_dir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">attrs</span><span class="o">.</span><span class="n">field</span><span class="p">()</span>
@@ -362,9 +377,9 @@ <h1>Source code for gwf.backends.base</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=e81f84f5"></script>
+</div><script src="../../../../_static/documentation_options.js?v=f124a214"></script>
     <script src="../../../../_static/doctools.js?v=888ff710"></script>
-    <script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/scripts/furo.js?v=32e29ea5"></script>
     </body>
 </html>