Deployed 41ce5c3 to dev with MkDocs 1.6.1 and mike 2.1.3

jaxleyverse · Sep 16, 2024 · ba33d36 · ba33d36
1 parent aa673fc
commit ba33d36
Show file tree

Hide file tree

Showing 10 changed files with 431 additions and 243 deletions.
diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/reference/mechanisms/index.html b/dev/reference/mechanisms/index.html
@@ -731,6 +731,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#jaxley.channels.channel.Channel.init_state" class="md-nav__link">
+    <span class="md-ellipsis">
+      init_state
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -1209,6 +1218,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#jaxley.channels.channel.Channel.init_state" class="md-nav__link">
+    <span class="md-ellipsis">
+      init_state
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -1606,7 +1624,17 @@ <h2 id="channel">Channel<a class="headerlink" href="#channel" title="Permanent l
 <span class="normal">78</span>
 <span class="normal">79</span>
 <span class="normal">80</span>
-<span class="normal">81</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">Channel</span><span class="p">:</span>
+<span class="normal">81</span>
+<span class="normal">82</span>
+<span class="normal">83</span>
+<span class="normal">84</span>
+<span class="normal">85</span>
+<span class="normal">86</span>
+<span class="normal">87</span>
+<span class="normal">88</span>
+<span class="normal">89</span>
+<span class="normal">90</span>
+<span class="normal">91</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">Channel</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Channel base class. All channels inherit from this class.</span>
 
 <span class="sd">    As in NEURON, a `Channel` is considered a distributed process, which means that its</span>
@@ -1678,6 +1706,16 @@ <h2 id="channel">Channel<a class="headerlink" href="#channel" title="Permanent l
 <span class="sd">            Current in `uA/cm2`.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+
+    <span class="k">def</span> <span class="nf">init_state</span><span class="p">(</span>
+        <span class="bp">self</span><span class="p">,</span>
+        <span class="n">states</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">],</span>
+        <span class="n">v</span><span class="p">:</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
+        <span class="n">params</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">],</span>
+        <span class="n">delta_t</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+    <span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Initialize states of channel.&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="p">{}</span>
 </code></pre></div></td></tr></table></div>
               </details>
 
@@ -1976,6 +2014,44 @@ <h3 id="jaxley.channels.channel.Channel.compute_current" class="doc doc-heading"
 <div class="doc doc-object doc-function">
 
 
+<h3 id="jaxley.channels.channel.Channel.init_state" class="doc doc-heading">
+            <code class=" language-python"><span class="n">init_state</span><span class="p">(</span><span class="n">states</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">delta_t</span><span class="p">)</span></code>
+
+<a href="#jaxley.channels.channel.Channel.init_state" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+        <p>Initialize states of channel.</p>
+
+            <details class="quote">
+              <summary>Source code in <code>jaxley/channels/channel.py</code></summary>
+              <div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">83</span>
+<span class="normal">84</span>
+<span class="normal">85</span>
+<span class="normal">86</span>
+<span class="normal">87</span>
+<span class="normal">88</span>
+<span class="normal">89</span>
+<span class="normal">90</span>
+<span class="normal">91</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">init_state</span><span class="p">(</span>
+    <span class="bp">self</span><span class="p">,</span>
+    <span class="n">states</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">],</span>
+    <span class="n">v</span><span class="p">:</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
+    <span class="n">params</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">],</span>
+    <span class="n">delta_t</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+<span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialize states of channel.&quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="p">{}</span>
+</code></pre></div></td></tr></table></div>
+            </details>
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
 <h3 id="jaxley.channels.channel.Channel.update_states" class="doc doc-heading">
             <code class=" language-python"><span class="n">update_states</span><span class="p">(</span><span class="n">states</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span></code>