doc updates [skip ci]

jonescompneurolab · Nov 22, 2024 · 150cb5e · 150cb5e
1 parent 4de731e
commit 150cb5e
Show file tree

Hide file tree

Showing 67 changed files with 260 additions and 193 deletions.
diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/dev/_downloads/0c1426a47f20507b843bbb8573dadaa3/plot_batch_simulate.zip b/dev/_downloads/0c1426a47f20507b843bbb8573dadaa3/plot_batch_simulate.zip
diff --git a/dev/_downloads/2614b7213bd2fa80a84b0cf766148cc7/plot_simulate_mpi_backend.zip b/dev/_downloads/2614b7213bd2fa80a84b0cf766148cc7/plot_simulate_mpi_backend.zip
diff --git a/dev/_downloads/31b0cbd558bb534ea1308033c541c1a1/plot_simulate_gamma.zip b/dev/_downloads/31b0cbd558bb534ea1308033c541c1a1/plot_simulate_gamma.zip
diff --git a/dev/_downloads/4698e321dc8babc51e3f731fbbbb4790/plot_simulate_beta.zip b/dev/_downloads/4698e321dc8babc51e3f731fbbbb4790/plot_simulate_beta.zip
diff --git a/dev/_downloads/4cab0857915100102bb20deaee521dce/plot_simulate_somato.zip b/dev/_downloads/4cab0857915100102bb20deaee521dce/plot_simulate_somato.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_downloads/93e1957cfd9f602f00fa2fece56bbb01/plot_simulate_alpha.zip b/dev/_downloads/93e1957cfd9f602f00fa2fece56bbb01/plot_simulate_alpha.zip
diff --git a/dev/_downloads/9575eddd15339b520cfc58b84c61894f/optimize_evoked.zip b/dev/_downloads/9575eddd15339b520cfc58b84c61894f/optimize_evoked.zip
diff --git a/dev/_downloads/a92d5ddbd18aab04d0bb7ecf25fa72b1/plot_connectivity.zip b/dev/_downloads/a92d5ddbd18aab04d0bb7ecf25fa72b1/plot_connectivity.zip
diff --git a/dev/_downloads/b52c981e7b898beab8949a80ade71521/optimize_rhythmic.zip b/dev/_downloads/b52c981e7b898beab8949a80ade71521/optimize_rhythmic.zip
diff --git a/dev/_downloads/b59686934008548eb89bf765a441876a/plot_simulate_evoked.zip b/dev/_downloads/b59686934008548eb89bf765a441876a/plot_simulate_evoked.zip
diff --git a/dev/_downloads/bd443592db7acfe1108885a60fad050f/plot_firing_pattern.zip b/dev/_downloads/bd443592db7acfe1108885a60fad050f/plot_firing_pattern.zip
diff --git a/dev/_downloads/ce5638da816fd451dce1dc7090680c16/plot_hnn_animation.zip b/dev/_downloads/ce5638da816fd451dce1dc7090680c16/plot_hnn_animation.zip
diff --git a/dev/_downloads/f9a3312a1c57beb716f8b8a31320269a/plot_record_extracellular_potentials.zip b/dev/_downloads/f9a3312a1c57beb716f8b8a31320269a/plot_record_extracellular_potentials.zip
diff --git a/dev/_images/sphx_glr_plot_connectivity_003.png b/dev/_images/sphx_glr_plot_connectivity_003.png
diff --git a/dev/_images/sphx_glr_plot_connectivity_004.png b/dev/_images/sphx_glr_plot_connectivity_004.png
diff --git a/dev/_images/sphx_glr_plot_connectivity_005.png b/dev/_images/sphx_glr_plot_connectivity_005.png
diff --git a/dev/_images/sphx_glr_plot_firing_pattern_002.png b/dev/_images/sphx_glr_plot_firing_pattern_002.png
diff --git a/dev/_images/sphx_glr_plot_firing_pattern_003.png b/dev/_images/sphx_glr_plot_firing_pattern_003.png
diff --git a/dev/_images/sphx_glr_plot_firing_pattern_004.png b/dev/_images/sphx_glr_plot_firing_pattern_004.png
diff --git a/dev/_images/sphx_glr_plot_record_extracellular_potentials_003.png b/dev/_images/sphx_glr_plot_record_extracellular_potentials_003.png
diff --git a/dev/_images/sphx_glr_plot_record_extracellular_potentials_thumb.png b/dev/_images/sphx_glr_plot_record_extracellular_potentials_thumb.png
diff --git a/dev/_images/sphx_glr_plot_simulate_beta_001.png b/dev/_images/sphx_glr_plot_simulate_beta_001.png
diff --git a/dev/_images/sphx_glr_plot_simulate_beta_002.png b/dev/_images/sphx_glr_plot_simulate_beta_002.png
diff --git a/dev/_images/sphx_glr_plot_simulate_beta_003.png b/dev/_images/sphx_glr_plot_simulate_beta_003.png
diff --git a/dev/_images/sphx_glr_plot_simulate_beta_thumb.png b/dev/_images/sphx_glr_plot_simulate_beta_thumb.png
diff --git a/dev/_images/sphx_glr_plot_simulate_gamma_001.png b/dev/_images/sphx_glr_plot_simulate_gamma_001.png
diff --git a/dev/_images/sphx_glr_plot_simulate_gamma_004.png b/dev/_images/sphx_glr_plot_simulate_gamma_004.png
diff --git a/dev/_images/sphx_glr_plot_simulate_gamma_006.png b/dev/_images/sphx_glr_plot_simulate_gamma_006.png
diff --git a/dev/_images/sphx_glr_plot_simulate_somato_002.png b/dev/_images/sphx_glr_plot_simulate_somato_002.png
diff --git a/dev/_images/sphx_glr_plot_simulate_somato_thumb.png b/dev/_images/sphx_glr_plot_simulate_somato_thumb.png
diff --git a/dev/_modules/hnn_core/cell_response.html b/dev/_modules/hnn_core/cell_response.html
@@ -428,7 +428,8 @@ <h1>Source code for hnn_core.cell_response</h1><div class="highlight"><pre>
 
         <span class="k">return</span> <span class="n">spike_rates</span></div>
 
-<div class="viewcode-block" id="CellResponse.plot_spikes_raster"><a class="viewcode-back" href="../../generated/hnn_core.CellResponse.html#hnn_core.CellResponse.plot_spikes_raster">[docs]</a>    <span class="k">def</span> <span class="nf">plot_spikes_raster</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trial_idx</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">show</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+<div class="viewcode-block" id="CellResponse.plot_spikes_raster"><a class="viewcode-back" href="../../generated/hnn_core.CellResponse.html#hnn_core.CellResponse.plot_spikes_raster">[docs]</a>    <span class="k">def</span> <span class="nf">plot_spikes_raster</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trial_idx</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">show</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+                           <span class="n">colors</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Plot the aggregate spiking activity according to cell type.</span>
 
 <span class="sd">        Parameters</span>
@@ -439,14 +440,17 @@ <h1>Source code for hnn_core.cell_response</h1><div class="highlight"><pre>
 <span class="sd">            An axis object from matplotlib. If None, a new figure is created.</span>
 <span class="sd">        show : bool</span>
 <span class="sd">            If True, show the figure.</span>
+<span class="sd">        colors: list of str | None</span>
+<span class="sd">            Optional custom colors to plot. Default will use the color cycler.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        fig : instance of matplotlib Figure</span>
 <span class="sd">            The matplotlib figure object.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="n">plot_spikes_raster</span><span class="p">(</span>
-            <span class="n">cell_response</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span> <span class="n">trial_idx</span><span class="o">=</span><span class="n">trial_idx</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">,</span> <span class="n">show</span><span class="o">=</span><span class="n">show</span><span class="p">)</span></div>
+            <span class="n">cell_response</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span> <span class="n">trial_idx</span><span class="o">=</span><span class="n">trial_idx</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">,</span> <span class="n">show</span><span class="o">=</span><span class="n">show</span><span class="p">,</span>
+            <span class="n">colors</span><span class="o">=</span><span class="n">colors</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="CellResponse.plot_spikes_hist"><a class="viewcode-back" href="../../generated/hnn_core.CellResponse.html#hnn_core.CellResponse.plot_spikes_hist">[docs]</a>    <span class="k">def</span> <span class="nf">plot_spikes_hist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trial_idx</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">spike_types</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                          <span class="n">color</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">invert_spike_types</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">show</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>