Deploying to gh-pages from @ 0558304 🚀

TIGRLab · Oct 17, 2023 · 6cf7061 · 6cf7061
1 parent 6b1996b
commit 6cf7061
Show file tree

Hide file tree

Showing 28 changed files with 678 additions and 445 deletions.
diff --git a/.doctrees/api/datman.config.doctree b/.doctrees/api/datman.config.doctree
diff --git a/.doctrees/api/datman.dashboard.doctree b/.doctrees/api/datman.dashboard.doctree
diff --git a/.doctrees/api/datman.exceptions.doctree b/.doctrees/api/datman.exceptions.doctree
diff --git a/.doctrees/api/datman.exporters.doctree b/.doctrees/api/datman.exporters.doctree
diff --git a/.doctrees/api/datman.fs_log_scraper.doctree b/.doctrees/api/datman.fs_log_scraper.doctree
diff --git a/.doctrees/api/datman.header_checks.doctree b/.doctrees/api/datman.header_checks.doctree
diff --git a/.doctrees/api/datman.metrics.doctree b/.doctrees/api/datman.metrics.doctree
diff --git a/.doctrees/api/datman.scan.doctree b/.doctrees/api/datman.scan.doctree
diff --git a/.doctrees/api/datman.scan_list.doctree b/.doctrees/api/datman.scan_list.doctree
diff --git a/.doctrees/api/datman.scanid.doctree b/.doctrees/api/datman.scanid.doctree
diff --git a/.doctrees/api/datman.utils.doctree b/.doctrees/api/datman.utils.doctree
diff --git a/.doctrees/api/datman.xnat.doctree b/.doctrees/api/datman.xnat.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/api/datman.config.html b/api/datman.config.html
diff --git a/api/datman.dashboard.html b/api/datman.dashboard.html
diff --git a/api/datman.exceptions.html b/api/datman.exceptions.html
diff --git a/api/datman.exporters.html b/api/datman.exporters.html
diff --git a/api/datman.fs_log_scraper.html b/api/datman.fs_log_scraper.html
diff --git a/api/datman.header_checks.html b/api/datman.header_checks.html
@@ -108,47 +108,47 @@
 files.</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.check_bvals">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">check_bvals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">series_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standard_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L96"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.check_bvals" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">check_bvals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">series_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standard_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L96"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.check_bvals" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.compare_headers">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">compare_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">series</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standard</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tolerance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.compare_headers" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">compare_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">series</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standard</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tolerance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.compare_headers" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.construct_diffs">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">construct_diffs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">series_json</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standard_json</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignored_fields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tolerances</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dti</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.construct_diffs" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">construct_diffs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">series_json</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standard_json</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignored_fields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tolerances</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dti</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.construct_diffs" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.find_bvals">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">find_bvals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L107"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.find_bvals" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">find_bvals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L107"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.find_bvals" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.handle_diff">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">handle_diff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expected</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tolerance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L75"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.handle_diff" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">handle_diff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expected</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tolerance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L75"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.handle_diff" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.parse_file">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L11"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.parse_file" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L11"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.parse_file" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.read_json">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">read_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_file</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.read_json" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">read_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_file</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.read_json" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.remove_fields">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">remove_fields</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_contents</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L67"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.remove_fields" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">remove_fields</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_contents</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L67"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.remove_fields" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="datman.header_checks.write_diff_log">
-<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">write_diff_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">diffs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/21a9413/datman/header_checks.py#L119"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.write_diff_log" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">datman.header_checks.</span></span><span class="sig-name descname"><span class="pre">write_diff_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">diffs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/tigrlab/datman/blob/0558304/datman/header_checks.py#L119"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datman.header_checks.write_diff_log" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 </section>