Documentation

yinchi · May 5, 2024 · 72e1686 · 72e1686
1 parent 1ba2bda
commit 72e1686
Show file tree

Hide file tree

Showing 71 changed files with 1,302 additions and 206 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,3 +51,11 @@
 
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+
+html_context = {
+    'display_github': True,
+    'github_user': 'yinchi',
+    'github_repo': 'histopath-bim-des',
+    'github_version': 'main',
+    'conf_py_path': '/docs/',
+}
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 661ee7406388d085c75b2b522d567f0f
+config: 45d9ac09b073bccebfd8d6a9241ca14a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/_modules/histopath_bim_des/bim.html b/docs/html/_modules/histopath_bim_des/bim.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/arrivals.html b/docs/html/_modules/histopath_bim_des/config/arrivals.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/batching.html b/docs/html/_modules/histopath_bim_des/config/batching.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/config.html b/docs/html/_modules/histopath_bim_des/config/config.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/distributions.html b/docs/html/_modules/histopath_bim_des/config/distributions.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/global_vars.html b/docs/html/_modules/histopath_bim_des/config/global_vars.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/resources.html b/docs/html/_modules/histopath_bim_des/config/resources.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/runners.html b/docs/html/_modules/histopath_bim_des/config/runners.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>

diff --git a/docs/html/_modules/histopath_bim_des/config/tasks.html b/docs/html/_modules/histopath_bim_des/config/tasks.html
@@ -43,14 +43,25 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks 🔗</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../config.html">Model Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulation.html">Simulation and KPI extraction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../processes.html">Histopathology processes</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/yinchi/histopath-bim-des/tree/main/notebooks">Jupyter notebooks</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Technical</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation ⬇️</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../thirdparty.html">Third-party libraries 📚</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API reference 📖</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../apidoc/histopath_bim_des.html">histopath_bim_des package</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Indicies and Tables 🔍</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../search.html">Search Page</a></li>
 </ul>
 
         </div>