Update documentation

OpenCOMPES · Jan 14, 2025 · 35401bf · 35401bf
1 parent a475eb2
commit 35401bf
Show file tree

Hide file tree

Showing 30 changed files with 514 additions and 514 deletions.
diff --git a/specsanalyzer/latest/_modules/index.html b/specsanalyzer/latest/_modules/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; specsanalyzer 0.5.1.dev2+g5d28e05 documentation</title>
+    <title>Overview: module code &#8212; specsanalyzer 0.5.1.dev10+g0c6ed22 documentation</title>
 
 
 
@@ -29,15 +29,15 @@
   <link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 <link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
 
   <!-- So that users can add custom icons -->
   <script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
 
-    <script src="../_static/documentation_options.js?v=b7a8c58f"></script>
+    <script src="../_static/documentation_options.js?v=8ac8b1d2"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -46,15 +46,15 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/specsanalyzer/switcher.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev2+g5d28e05';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev10+g0c6ed22';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             true;
         </script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.5.1.dev2+g5d28e05" />
+  <meta name="docsearch:version" content="0.5.1.dev10+g0c6ed22" />
   </head>
 
 
@@ -116,7 +116,7 @@
 
 
 
-    <p class="title logo__title">specsanalyzer 0.5.1.dev2+g5d28e05 documentation</p>
+    <p class="title logo__title">specsanalyzer 0.5.1.dev10+g0c6ed22 documentation</p>
 
 </a></div>
 

diff --git a/specsanalyzer/latest/_modules/specsanalyzer/config.html b/specsanalyzer/latest/_modules/specsanalyzer/config.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>specsanalyzer.config &#8212; specsanalyzer 0.5.1.dev2+g5d28e05 documentation</title>
+    <title>specsanalyzer.config &#8212; specsanalyzer 0.5.1.dev10+g0c6ed22 documentation</title>
 
 
 
@@ -29,15 +29,15 @@
   <link href="../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 <link href="../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 
-    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
 
   <!-- So that users can add custom icons -->
   <script src="../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
 
-    <script src="../../_static/documentation_options.js?v=b7a8c58f"></script>
+    <script src="../../_static/documentation_options.js?v=8ac8b1d2"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -46,15 +46,15 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/specsanalyzer/switcher.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev2+g5d28e05';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev10+g0c6ed22';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             true;
         </script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.5.1.dev2+g5d28e05" />
+  <meta name="docsearch:version" content="0.5.1.dev10+g0c6ed22" />
   </head>
 
 
@@ -116,7 +116,7 @@
 
 
 
-    <p class="title logo__title">specsanalyzer 0.5.1.dev2+g5d28e05 documentation</p>
+    <p class="title logo__title">specsanalyzer 0.5.1.dev10+g0c6ed22 documentation</p>
 
 </a></div>
 
@@ -551,22 +551,22 @@
 
   <h1>Source code for specsanalyzer.config</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;This module contains a config library for loading yaml/json files into dicts&quot;&quot;&quot;</span>
-<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
-<span class="kn">import</span> <span class="nn">json</span>
-<span class="kn">import</span> <span class="nn">os</span>
-<span class="kn">import</span> <span class="nn">platform</span>
-<span class="kn">from</span> <span class="nn">importlib.util</span> <span class="kn">import</span> <span class="n">find_spec</span>
-<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">platform</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">importlib.util</span><span class="w"> </span><span class="kn">import</span> <span class="n">find_spec</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
 
-<span class="kn">import</span> <span class="nn">yaml</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">yaml</span>
 
 <span class="n">package_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">find_spec</span><span class="p">(</span><span class="s2">&quot;specsanalyzer&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">origin</span><span class="p">)</span>
 
 
 <div class="viewcode-block" id="parse_config">
 <a class="viewcode-back" href="../../specsanalyzer/config.html#specsanalyzer.config.parse_config">[docs]</a>
-<span class="k">def</span> <span class="nf">parse_config</span><span class="p">(</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_config</span><span class="p">(</span>
     <span class="n">config</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
     <span class="n">folder_config</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
     <span class="n">user_config</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -694,7 +694,7 @@ <h1>Source code for specsanalyzer.config</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="load_config">
 <a class="viewcode-back" href="../../specsanalyzer/config.html#specsanalyzer.config.load_config">[docs]</a>
-<span class="k">def</span> <span class="nf">load_config</span><span class="p">(</span><span class="n">config_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">load_config</span><span class="p">(</span><span class="n">config_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Loads config parameter files.</span>
 
 <span class="sd">    Args:</span>
@@ -728,7 +728,7 @@ <h1>Source code for specsanalyzer.config</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="save_config">
 <a class="viewcode-back" href="../../specsanalyzer/config.html#specsanalyzer.config.save_config">[docs]</a>
-<span class="k">def</span> <span class="nf">save_config</span><span class="p">(</span><span class="n">config_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">config_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">overwrite</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">save_config</span><span class="p">(</span><span class="n">config_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">config_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">overwrite</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function to save a given config dictionary to a json or yaml file. Normally, it loads any</span>
 <span class="sd">    existing file of the given name, and keeps any existing dictionary keys not present in the</span>
 <span class="sd">    provided dictionary. The overwrite option creates a fully empty dictionary first.</span>
@@ -761,7 +761,7 @@ <h1>Source code for specsanalyzer.config</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="complete_dictionary">
 <a class="viewcode-back" href="../../specsanalyzer/config.html#specsanalyzer.config.complete_dictionary">[docs]</a>
-<span class="k">def</span> <span class="nf">complete_dictionary</span><span class="p">(</span><span class="n">dictionary</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">base_dictionary</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">complete_dictionary</span><span class="p">(</span><span class="n">dictionary</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">base_dictionary</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Iteratively completes a dictionary from a base dictionary, by adding keys that are missing</span>
 <span class="sd">    in the dictionary, and are present in the base dictionary.</span>