Deploying to gh-pages from @ 0aac22c 🚀

resurfemg-org · Nov 12, 2024 · 9ea13c3 · 9ea13c3
1 parent 8a96b43
commit 9ea13c3
Show file tree

Hide file tree

Showing 69 changed files with 5,810 additions and 3,107 deletions.
diff --git a/.buildinfo b/.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: 5a835a4cd2aac12a628b7763ead9290d
+config: 6ab015c4f905a4aaa9e0d621b7a90566
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/resurfemg.config.config.rst.txt b/_sources/resurfemg.config.config.rst.txt
diff --git a/_sources/resurfemg.config.rst.txt b/_sources/resurfemg.config.rst.txt
diff --git a/_sources/resurfemg.data_connector.config.rst.txt b/_sources/resurfemg.data_connector.config.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.config module
+=======================================
+
+.. automodule:: resurfemg.data_connector.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.data_connector.data_classes.rst.txt b/_sources/resurfemg.data_connector.data_classes.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.data\_classes module
+==============================================
+
+.. automodule:: resurfemg.data_connector.data_classes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.data_connector.file_discovery.rst.txt b/_sources/resurfemg.data_connector.file_discovery.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.file\_discovery module
+================================================
+
+.. automodule:: resurfemg.data_connector.file_discovery
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.data_connector.peakset_class.rst.txt b/_sources/resurfemg.data_connector.peakset_class.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.peakset\_class module
+===============================================
+
+.. automodule:: resurfemg.data_connector.peakset_class
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.data_connector.rst.txt b/_sources/resurfemg.data_connector.rst.txt
@@ -7,7 +7,12 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
+   resurfemg.data_connector.config
    resurfemg.data_connector.converter_functions
+   resurfemg.data_connector.data_classes
+   resurfemg.data_connector.file_discovery
+   resurfemg.data_connector.peakset_class
+   resurfemg.data_connector.synthetic_data
    resurfemg.data_connector.tmsisdk_lite
 
 Module contents

diff --git a/_sources/resurfemg.data_connector.synthetic_data.rst.txt b/_sources/resurfemg.data_connector.synthetic_data.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.synthetic\_data module
+================================================
+
+.. automodule:: resurfemg.data_connector.synthetic_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.helper_functions.data_classes_quality_assessment.rst.txt b/_sources/resurfemg.helper_functions.data_classes_quality_assessment.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.helper\_functions.data\_classes\_quality\_assessment module
+=====================================================================
+
+.. automodule:: resurfemg.helper_functions.data_classes_quality_assessment
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.helper_functions.helper_functions.rst.txt b/_sources/resurfemg.helper_functions.helper_functions.rst.txt
diff --git a/_sources/resurfemg.helper_functions.math_operations.rst.txt b/_sources/resurfemg.helper_functions.math_operations.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.helper\_functions.math\_operations module
+===================================================
+
+.. automodule:: resurfemg.helper_functions.math_operations
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.helper_functions.rst.txt b/_sources/resurfemg.helper_functions.rst.txt
@@ -7,7 +7,9 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   resurfemg.helper_functions.helper_functions
+   resurfemg.helper_functions.data_classes_quality_assessment
+   resurfemg.helper_functions.math_operations
+   resurfemg.helper_functions.visualization
 
 Module contents
 ---------------

diff --git a/_sources/resurfemg.helper_functions.visualization.rst.txt b/_sources/resurfemg.helper_functions.visualization.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.helper\_functions.visualization module
+================================================
+
+.. automodule:: resurfemg.helper_functions.visualization
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.pipelines.ipy_widgets.rst.txt b/_sources/resurfemg.pipelines.ipy_widgets.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.pipelines.ipy\_widgets module
+=======================================
+
+.. automodule:: resurfemg.pipelines.ipy_widgets
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.pipelines.pipelines.rst.txt b/_sources/resurfemg.pipelines.pipelines.rst.txt
diff --git a/_sources/resurfemg.pipelines.processing.rst.txt b/_sources/resurfemg.pipelines.processing.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.pipelines.processing module
+=====================================
+
+.. automodule:: resurfemg.pipelines.processing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.pipelines.rst.txt b/_sources/resurfemg.pipelines.rst.txt
@@ -7,7 +7,9 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   resurfemg.pipelines.pipelines
+   resurfemg.pipelines.ipy_widgets
+   resurfemg.pipelines.processing
+   resurfemg.pipelines.synthetic_data
 
 Module contents
 ---------------

diff --git a/_sources/resurfemg.pipelines.synthetic_data.rst.txt b/_sources/resurfemg.pipelines.synthetic_data.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.pipelines.synthetic\_data module
+==========================================
+
+.. automodule:: resurfemg.pipelines.synthetic_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.postprocessing.quality_assessment.rst.txt b/_sources/resurfemg.postprocessing.quality_assessment.rst.txt
@@ -0,0 +1,7 @@
+resurfemg.postprocessing.quality\_assessment module
+===================================================
+
+.. automodule:: resurfemg.postprocessing.quality_assessment
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/resurfemg.postprocessing.rst.txt b/_sources/resurfemg.postprocessing.rst.txt
@@ -10,6 +10,7 @@ Submodules
    resurfemg.postprocessing.baseline
    resurfemg.postprocessing.event_detection
    resurfemg.postprocessing.features
+   resurfemg.postprocessing.quality_assessment
 
 Module contents
 ---------------

diff --git a/_sources/resurfemg.rst.txt b/_sources/resurfemg.rst.txt
@@ -8,13 +8,11 @@ Subpackages
    :maxdepth: 4
 
    resurfemg.cli
-   resurfemg.config
    resurfemg.data_connector
    resurfemg.helper_functions
    resurfemg.pipelines
    resurfemg.postprocessing
    resurfemg.preprocessing
-   resurfemg.visualization
 
 Module contents
 ---------------

diff --git a/_sources/resurfemg.visualization.rst.txt b/_sources/resurfemg.visualization.rst.txt
diff --git a/_sources/resurfemg.visualization.visualization.rst.txt b/_sources/resurfemg.visualization.visualization.rst.txt
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.3.0',
+    VERSION: '0.3.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/_static/searchtools.js b/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
 
   htmlToText: (htmlString, anchor) => {
     const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
-    for (const removalQuery of [".headerlinks", "script", "style"]) {
+    for (const removalQuery of [".headerlink", "script", "style"]) {
       htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
     }
     if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
     for (const [title, foundTitles] of Object.entries(allTitles)) {
       if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
         for (const [file, id] of foundTitles) {
-          let score = Math.round(100 * queryLower.length / title.length)
+          const score = Math.round(Scorer.title * queryLower.length / title.length);
+          const boost = titles[file] === title ? 1 : 0;  // add a boost for document titles
           normalResults.push([
             docNames[file],
             titles[file] !== title ? `${titles[file]} > ${title}` : title,
             id !== null ? "#" + id : "",
             null,
-            score,
+            score + boost,
             filenames[file],
           ]);
         }

diff --git a/developers.html b/developers.html
@@ -5,18 +5,18 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Developer’s Guide &#8212; resurfemg 0.3.0 documentation</title>
+    <title>Developer’s Guide &#8212; resurfemg 0.3.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/nature.css?v=0f882399" />
-    <script src="_static/documentation_options.js?v=e259d695"></script>
+    <script src="_static/documentation_options.js?v=4621528c"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Medical Professional Documentation" href="medical-professionals.html" />
-    <link rel="prev" title="resurfemg.visualization.visualization module" href="resurfemg.visualization.visualization.html" /> 
+    <link rel="prev" title="resurfemg.preprocessing.filtering module" href="resurfemg.preprocessing.filtering.html" /> 
   </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
+    <div class="related" role="navigation" aria-label="Related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -29,9 +29,9 @@ <h3>Navigation</h3>
           <a href="medical-professionals.html" title="Medical Professional Documentation"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="resurfemg.visualization.visualization.html" title="resurfemg.visualization.visualization module"
+          <a href="resurfemg.preprocessing.filtering.html" title="resurfemg.preprocessing.filtering module"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">resurfemg 0.3.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">resurfemg 0.3.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Developer’s Guide</a></li> 
       </ul>
     </div>  
@@ -134,7 +134,7 @@ <h3>Style<a class="headerlink" href="#style" title="Link to this heading">¶</a>
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
@@ -160,8 +160,8 @@ <h3><a href="index.html">Table of Contents</a></h3>
   </div>
   <div>
     <h4>Previous topic</h4>
-    <p class="topless"><a href="resurfemg.visualization.visualization.html"
-                          title="previous chapter">resurfemg.visualization.visualization module</a></p>
+    <p class="topless"><a href="resurfemg.preprocessing.filtering.html"
+                          title="previous chapter">resurfemg.preprocessing.filtering module</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
@@ -189,7 +189,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="related navigation">
+    <div class="related" role="navigation" aria-label="Related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -202,15 +202,15 @@ <h3>Navigation</h3>
           <a href="medical-professionals.html" title="Medical Professional Documentation"
              >next</a> |</li>
         <li class="right" >
-          <a href="resurfemg.visualization.visualization.html" title="resurfemg.visualization.visualization module"
+          <a href="resurfemg.preprocessing.filtering.html" title="resurfemg.preprocessing.filtering module"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">resurfemg 0.3.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">resurfemg 0.3.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Developer’s Guide</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright 2022, c.moore@esciencecenter.nl.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    &#169; Copyright 2022, e.oppersma@utwente.nl.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
     </div>
   </body>
 </html>