deploy: 340e375

int-brain-lab · Oct 1, 2024 · fb4f42f · fb4f42f
commit fb4f42f
Show file tree

Hide file tree

Showing 76 changed files with 8,343 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +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: cc2180c3d0f3a6b4fc034fcd22d34886
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/api/iblqt.core.ColoredDataFrameTableModel.doctree b/.doctrees/api/iblqt.core.ColoredDataFrameTableModel.doctree
diff --git a/.doctrees/api/iblqt.core.DataFrameTableModel.doctree b/.doctrees/api/iblqt.core.DataFrameTableModel.doctree
diff --git a/.doctrees/api/iblqt.core.doctree b/.doctrees/api/iblqt.core.doctree
diff --git a/.doctrees/api/iblqt.doctree b/.doctrees/api/iblqt.doctree
diff --git a/.doctrees/api/iblqt.widgets.StatefulButton.doctree b/.doctrees/api/iblqt.widgets.StatefulButton.doctree
diff --git a/.doctrees/api/iblqt.widgets.doctree b/.doctrees/api/iblqt.widgets.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/dev_guide.doctree b/.doctrees/dev_guide.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/iblqt/core.html b/_modules/iblqt/core.html
diff --git a/_modules/iblqt/widgets.html b/_modules/iblqt/widgets.html
@@ -0,0 +1,199 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>iblqt.widgets &mdash; iblqt 0.1.1 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../_static/documentation_options.js?v=a58bc63e"></script>
+        <script src="../../_static/doctools.js?v=9a2dae69"></script>
+        <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../index.html" class="icon icon-home">
+            iblqt
+          </a>
+              <div class="version">
+                0.1.1
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </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 internal" href="../../dev_guide.html">Developer Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Links</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/int-brain-lab/iblqt">GitHub</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/iblqt">PyPI</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../index.html">iblqt</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">iblqt.widgets</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for iblqt.widgets</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;Graphical user interface components.&quot;&quot;&quot;</span>
+
+<span class="kn">from</span> <span class="nn">qtpy.QtWidgets</span> <span class="kn">import</span> <span class="n">QPushButton</span>
+<span class="kn">from</span> <span class="nn">qtpy.QtCore</span> <span class="kn">import</span> <span class="n">Signal</span><span class="p">,</span> <span class="n">Slot</span><span class="p">,</span> <span class="n">Property</span>
+
+
+<div class="viewcode-block" id="StatefulButton">
+<a class="viewcode-back" href="../../api/iblqt.widgets.StatefulButton.html#iblqt.widgets.StatefulButton">[docs]</a>
+<span class="k">class</span> <span class="nc">StatefulButton</span><span class="p">(</span><span class="n">QPushButton</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A QPushButton that maintains an active/inactive state.&quot;&quot;&quot;</span>
+
+    <span class="n">clickedWhileActive</span> <span class="o">=</span> <span class="n">Signal</span><span class="p">()</span>  <span class="c1"># type: Signal</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Emitted when the button is clicked while it is in the active state.&quot;&quot;&quot;</span>
+
+    <span class="n">clickedWhileInactive</span> <span class="o">=</span> <span class="n">Signal</span><span class="p">()</span>  <span class="c1"># type: Signal</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Emitted when the button is clicked while it is in the inactive state.&quot;&quot;&quot;</span>
+
+    <span class="n">stateChanged</span> <span class="o">=</span> <span class="n">Signal</span><span class="p">(</span><span class="nb">bool</span><span class="p">)</span>  <span class="c1"># type: Signal</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Emitted when the button&#39;s state has changed. The signal carries the new state </span>
+<span class="sd">    (True for active, False for inactive).&quot;&quot;&quot;</span>
+
+<div class="viewcode-block" id="StatefulButton.__init__">
+<a class="viewcode-back" href="../../api/iblqt.widgets.StatefulButton.html#iblqt.widgets.StatefulButton.__init__">[docs]</a>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">active</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="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Initialize the StatefulButton with the specified active state.</span>
+
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        *args : tuple</span>
+<span class="sd">            Positional arguments passed to QPushButton constructor.</span>
+<span class="sd">        active : bool, optional</span>
+<span class="sd">            Initial state of the button (default is False).</span>
+<span class="sd">        **kwargs : dict</span>
+<span class="sd">            Keyword arguments passed to QPushButton constructor.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_isActive</span> <span class="o">=</span> <span class="n">active</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">clicked</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_onClick</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="StatefulButton.getActive">
+<a class="viewcode-back" href="../../api/iblqt.widgets.StatefulButton.html#iblqt.widgets.StatefulButton.getActive">[docs]</a>
+    <span class="k">def</span> <span class="nf">getActive</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get the active state of the button.</span>
+
+<span class="sd">        Returns</span>
+<span class="sd">        -------</span>
+<span class="sd">        bool</span>
+<span class="sd">            True if the button is active, False otherwise.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_isActive</span></div>
+
+
+<div class="viewcode-block" id="StatefulButton.setActive">
+<a class="viewcode-back" href="../../api/iblqt.widgets.StatefulButton.html#iblqt.widgets.StatefulButton.setActive">[docs]</a>
+    <span class="nd">@Slot</span><span class="p">(</span><span class="nb">bool</span><span class="p">)</span>
+    <span class="k">def</span> <span class="nf">setActive</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="nb">bool</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Set the active state of the button.</span>
+
+<span class="sd">        Emits `stateChanged` if the state has changed.</span>
+
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        value : bool</span>
+<span class="sd">            The new active state of the button.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_isActive</span> <span class="o">!=</span> <span class="n">value</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_isActive</span> <span class="o">=</span> <span class="n">value</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">stateChanged</span><span class="o">.</span><span class="n">emit</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_isActive</span><span class="p">)</span></div>
+
+
+    <span class="n">active</span> <span class="o">=</span> <span class="n">Property</span><span class="p">(</span><span class="nb">bool</span><span class="p">,</span> <span class="n">fget</span><span class="o">=</span><span class="n">getActive</span><span class="p">,</span> <span class="n">fset</span><span class="o">=</span><span class="n">setActive</span><span class="p">,</span> <span class="n">notify</span><span class="o">=</span><span class="n">stateChanged</span><span class="p">)</span>  <span class="c1"># type: Property</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The active state of the button.&quot;&quot;&quot;</span>
+
+    <span class="nd">@Slot</span><span class="p">()</span>
+    <span class="k">def</span> <span class="nf">_onClick</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Handle the button click event.</span>
+
+<span class="sd">        Emits `clickedWhileActive` if the button is active,</span>
+<span class="sd">        otherwise emits `clickedWhileInactive`.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_isActive</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">clickedWhileActive</span><span class="o">.</span><span class="n">emit</span><span class="p">()</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">clickedWhileInactive</span><span class="o">.</span><span class="n">emit</span><span class="p">()</span></div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, International Brain Laboratory.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,115 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; iblqt 0.1.1 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=a58bc63e"></script>
+        <script src="../_static/doctools.js?v=9a2dae69"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            iblqt
+          </a>
+              <div class="version">
+                0.1.1
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </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 internal" href="../dev_guide.html">Developer Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Links</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/int-brain-lab/iblqt">GitHub</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/iblqt">PyPI</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">iblqt</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="PyQt5/QtCore.html">PyQt5.QtCore</a></li>
+<li><a href="iblqt/core.html">iblqt.core</a></li>
+<li><a href="iblqt/widgets.html">iblqt.widgets</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, International Brain Laboratory.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,9 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: api
+   :template: custom-module-template.rst
+   :recursive:
+
+   iblqt
diff --git a/_sources/api/iblqt.core.ColoredDataFrameTableModel.rst.txt b/_sources/api/iblqt.core.ColoredDataFrameTableModel.rst.txt
@@ -0,0 +1,9 @@
+iblqt.core.ColoredDataFrameTableModel
+=====================================
+
+.. currentmodule:: iblqt.core
+
+.. autoclass:: ColoredDataFrameTableModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/iblqt.core.DataFrameTableModel.rst.txt b/_sources/api/iblqt.core.DataFrameTableModel.rst.txt
@@ -0,0 +1,9 @@
+iblqt.core.DataFrameTableModel
+==============================
+
+.. currentmodule:: iblqt.core
+
+.. autoclass:: DataFrameTableModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/iblqt.core.rst.txt b/_sources/api/iblqt.core.rst.txt
@@ -0,0 +1,15 @@
+iblqt.core
+==========
+
+.. automodule:: iblqt.core
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :nosignatures:
+      :toctree:
+      :template: custom-class-template.rst
+
+      ColoredDataFrameTableModel
+      DataFrameTableModel
+
diff --git a/_sources/api/iblqt.rst.txt b/_sources/api/iblqt.rst.txt
@@ -0,0 +1,15 @@
+iblqt
+=====
+
+.. automodule:: iblqt
+
+.. rubric:: Modules
+
+.. autosummary::
+   :nosignatures:
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+
+   core
+   widgets
diff --git a/_sources/api/iblqt.widgets.StatefulButton.rst.txt b/_sources/api/iblqt.widgets.StatefulButton.rst.txt
@@ -0,0 +1,9 @@
+iblqt.widgets.StatefulButton
+============================
+
+.. currentmodule:: iblqt.widgets
+
+.. autoclass:: StatefulButton
+   :members:
+   :undoc-members:
+   :show-inheritance: