doc updates [skip ci]

jonescompneurolab · Nov 25, 2024 · ab9e13a · ab9e13a
1 parent 150cb5e
commit ab9e13a
Show file tree

Hide file tree

Showing 76 changed files with 208 additions and 388 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/gui/gui.html b/dev/_modules/hnn_core/gui/gui.html
@@ -291,7 +291,7 @@ <h1>Source code for hnn_core.gui.gui</h1><div class="highlight"><pre>
             <span class="s1">&#39;output_type&#39;</span><span class="p">:</span> <span class="s1">&#39;stream&#39;</span><span class="p">,</span>
             <span class="s1">&#39;text&#39;</span><span class="p">:</span> <span class="n">formatted_record</span> <span class="o">+</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span>
         <span class="p">}</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">outputs</span> <span class="o">=</span> <span class="p">(</span><span class="n">new_output</span><span class="p">,</span> <span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">outputs</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">outputs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">outputs</span> <span class="o">+</span> <span class="p">(</span><span class="n">new_output</span><span class="p">,</span> <span class="p">)</span>
 
 
 <div class="viewcode-block" id="HNNGUI"><a class="viewcode-back" href="../../../generated/hnn_core.gui.HNNGUI.html#hnn_core.gui.HNNGUI">[docs]</a><span class="k">class</span> <span class="nc">HNNGUI</span><span class="p">:</span>

diff --git a/dev/_sources/auto_examples/howto/plot_batch_simulate.rst.txt b/dev/_sources/auto_examples/howto/plot_batch_simulate.rst.txt
@@ -226,25 +226,25 @@ Run the batch simulation and collect the results.
     [Parallel(n_jobs=10)]: Done   1 tasks      | elapsed:    1.7s
     Simulation results: {'summary_statistics': [[{'min_peak': -1.9487233699162363e-05, 'max_peak': 2.438299811172486e-05}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 5.406961258004377e-05}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 0.00011922352353898099}], [{'min_peak': -0.0006636604554164317, 'max_peak': 0.0011404645089040637}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 0.0009097461915339956}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 0.0011362095936085991}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 0.001168458230350182}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 0.0012737618628301784}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 0.0014391544369764205}], [{'min_peak': -1.9487233699162363e-05, 'max_peak': 0.001616939552849071}]], 'simulated_data': [[{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 9.999999999999999e-06, 'weight_pyr': 9.999999999999999e-05}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe67f6ff7c0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 9.999999999999999e-06, 'weight_pyr': 9.999999999999999e-05}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c19741b50>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 2.0235896477251556e-05, 'weight_pyr': 0.00021544346900318845}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe6843df9d0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 2.0235896477251556e-05, 'weight_pyr': 0.00021544346900318845}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c2136de20>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 4.094915062380427e-05, 'weight_pyr': 0.00046415888336127773}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe68437ec40>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 4.094915062380427e-05, 'weight_pyr': 0.00046415888336127773}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c229db940>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 8.286427728546842e-05, 'weight_pyr': 0.001}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe6842f8b20>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 8.286427728546842e-05, 'weight_pyr': 0.001}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c213af790>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 0.00016768329368110083, 'weight_pyr': 0.002154434690031882}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe68e48b9a0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 0.00016768329368110083, 'weight_pyr': 0.002154434690031882}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c2ac5b4f0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 0.00033932217718953293, 'weight_pyr': 0.004641588833612777}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe68e0baeb0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 0.00033932217718953293, 'weight_pyr': 0.004641588833612777}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c211fd670>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 0.0006866488450042998, 'weight_pyr': 0.01}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe68519c220>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 0.0006866488450042998, 'weight_pyr': 0.01}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c297f19d0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 0.0013894954943731376, 'weight_pyr': 0.021544346900318822}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe68cf35bb0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 0.0013894954943731376, 'weight_pyr': 0.021544346900318822}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c34736790>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 0.002811768697974231, 'weight_pyr': 0.046415888336127774}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe68ec8c460>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
+    3 L5 basket cells>, 'param_values': {'weight_basket': 0.002811768697974231, 'weight_pyr': 0.046415888336127774}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c2acfb1f0>]}], [{'net': <Network | 3 x 3 Pyramidal cells (L2, L5)
     3 L2 basket cells
-    3 L5 basket cells>, 'param_values': {'weight_basket': 0.005689866029018299, 'weight_pyr': 0.09999999999999999}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7fe68cf5d640>]}]]}
+    3 L5 basket cells>, 'param_values': {'weight_basket': 0.005689866029018299, 'weight_pyr': 0.09999999999999999}, 'dpl': [<hnn_core.dipole.Dipole object at 0x7f8c1944a610>]}]]}
 
 
 
@@ -333,7 +333,7 @@ dipole activity changes as we vary the synaptic strength parameter.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 17.718 seconds)
+   **Total running time of the script:** (0 minutes 17.916 seconds)
 
 
 .. _sphx_glr_download_auto_examples_howto_plot_batch_simulate.py:

diff --git a/dev/_sources/auto_examples/howto/plot_connectivity.rst.txt b/dev/_sources/auto_examples/howto/plot_connectivity.rst.txt
@@ -478,7 +478,7 @@ the aggregate current dipole.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (1 minutes 24.823 seconds)
+   **Total running time of the script:** (1 minutes 31.708 seconds)
 
 
 .. _sphx_glr_download_auto_examples_howto_plot_connectivity.py:

diff --git a/dev/_sources/auto_examples/howto/plot_firing_pattern.rst.txt b/dev/_sources/auto_examples/howto/plot_firing_pattern.rst.txt
@@ -321,7 +321,7 @@ read spikes back in, we can use wildcard expressions.
 
     /home/circleci/project/examples/howto/plot_firing_pattern.py:111: DeprecationWarning: Writing cell response to txt files is deprecated and will be removed in future versions. Please save cell response along with network
       net.cell_response.write(op.join(tmp_dir_name, 'spk_%d.txt'))
-    Writing file /tmp/tmpzwj9ilxi/spk_0.txt
+    Writing file /tmp/tmpnwin81z7/spk_0.txt
     /home/circleci/project/examples/howto/plot_firing_pattern.py:112: DeprecationWarning: Reading cell response from txt files is deprecated and will be removed in future versions. Please load cell response along with simulated network
       cell_response = read_spikes(op.join(tmp_dir_name, 'spk_*.txt'))
 
@@ -407,7 +407,7 @@ raster plots and histograms for the pyramidal cells.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 30.489 seconds)
+   **Total running time of the script:** (0 minutes 32.636 seconds)
 
 
 .. _sphx_glr_download_auto_examples_howto_plot_firing_pattern.py:

diff --git a/dev/_sources/auto_examples/howto/plot_hnn_animation.rst.txt b/dev/_sources/auto_examples/howto/plot_hnn_animation.rst.txt
@@ -110,7 +110,7 @@ the 3D structure of the network.
 
  .. code-block:: none
 
-    /home/circleci/miniconda/envs/testenv/lib/python3.8/site-packages/hnn_core/viz.py:1073: UserWarning: The figure layout has changed to tight
+    /home/circleci/miniconda/envs/testenv/lib/python3.8/site-packages/hnn_core/viz.py:1029: UserWarning: The figure layout has changed to tight
       plt.tight_layout()
 
     <Figure size 640x480 with 2 Axes>
@@ -221,14 +221,14 @@ can adjust the xyz limits of the plot to better visualize the network.
  .. code-block:: none
 
 
-    <matplotlib.animation.FuncAnimation object at 0x7fe68e0ba7c0>
+    <matplotlib.animation.FuncAnimation object at 0x7f8c20873a30>
 
 
 
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (1 minutes 1.875 seconds)
+   **Total running time of the script:** (1 minutes 4.384 seconds)
 
 
 .. _sphx_glr_download_auto_examples_howto_plot_hnn_animation.py:

diff --git a/dev/_sources/auto_examples/howto/plot_record_extracellular_potentials.rst.txt b/dev/_sources/auto_examples/howto/plot_record_extracellular_potentials.rst.txt
@@ -265,7 +265,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 41.338 seconds)
+   **Total running time of the script:** (0 minutes 43.970 seconds)
 
 
 .. _sphx_glr_download_auto_examples_howto_plot_record_extracellular_potentials.py:

diff --git a/dev/_sources/auto_examples/howto/plot_simulate_mpi_backend.rst.txt b/dev/_sources/auto_examples/howto/plot_simulate_mpi_backend.rst.txt
@@ -172,7 +172,7 @@ start the simulation across the number of processors (cores) specified by
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 21.770 seconds)
+   **Total running time of the script:** (0 minutes 22.136 seconds)
 
 
 .. _sphx_glr_download_auto_examples_howto_plot_simulate_mpi_backend.py:

diff --git a/dev/_sources/auto_examples/howto/sg_execution_times.rst.txt b/dev/_sources/auto_examples/howto/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**04:18.013** total execution time for 8 files **from auto_examples/howto**:
+**04:32.750** total execution time for 8 files **from auto_examples/howto**:
 
 .. container::
 
@@ -33,22 +33,22 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_auto_examples_howto_plot_connectivity.py` (``plot_connectivity.py``)
-     - 01:24.823
+     - 01:31.708
      - 0.0
    * - :ref:`sphx_glr_auto_examples_howto_plot_hnn_animation.py` (``plot_hnn_animation.py``)
-     - 01:01.875
+     - 01:04.384
      - 0.0
    * - :ref:`sphx_glr_auto_examples_howto_plot_record_extracellular_potentials.py` (``plot_record_extracellular_potentials.py``)
-     - 00:41.338
+     - 00:43.970
      - 0.0
    * - :ref:`sphx_glr_auto_examples_howto_plot_firing_pattern.py` (``plot_firing_pattern.py``)
-     - 00:30.489
+     - 00:32.636
      - 0.0
    * - :ref:`sphx_glr_auto_examples_howto_plot_simulate_mpi_backend.py` (``plot_simulate_mpi_backend.py``)
-     - 00:21.770
+     - 00:22.136
      - 0.0
    * - :ref:`sphx_glr_auto_examples_howto_plot_batch_simulate.py` (``plot_batch_simulate.py``)
-     - 00:17.718
+     - 00:17.916
      - 0.0
    * - :ref:`sphx_glr_auto_examples_howto_optimize_evoked.py` (``optimize_evoked.py``)
      - 00:00.000

diff --git a/dev/_sources/auto_examples/workflows/plot_simulate_alpha.rst.txt b/dev/_sources/auto_examples/workflows/plot_simulate_alpha.rst.txt
@@ -147,7 +147,7 @@ time with unique randomization. The drive is only connected to the
     Trial 1: 290.0 ms...
     Trial 1: 300.0 ms...
 
-    <hnn_core.dipole.Dipole object at 0x7fe68f3c1220>
+    <hnn_core.dipole.Dipole object at 0x7f8c2bd53040>
 
 
 
@@ -326,7 +326,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (1 minutes 35.843 seconds)
+   **Total running time of the script:** (1 minutes 41.573 seconds)
 
 
 .. _sphx_glr_download_auto_examples_workflows_plot_simulate_alpha.py:

diff --git a/dev/_sources/auto_examples/workflows/plot_simulate_beta.rst.txt b/dev/_sources/auto_examples/workflows/plot_simulate_beta.rst.txt
@@ -623,7 +623,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (3 minutes 0.967 seconds)
+   **Total running time of the script:** (3 minutes 21.735 seconds)
 
 
 .. _sphx_glr_download_auto_examples_workflows_plot_simulate_beta.py:

diff --git a/dev/_sources/auto_examples/workflows/plot_simulate_evoked.rst.txt b/dev/_sources/auto_examples/workflows/plot_simulate_evoked.rst.txt
@@ -453,7 +453,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (1 minutes 0.203 seconds)
+   **Total running time of the script:** (1 minutes 4.572 seconds)
 
 
 .. _sphx_glr_download_auto_examples_workflows_plot_simulate_evoked.py:

diff --git a/dev/_sources/auto_examples/workflows/plot_simulate_gamma.rst.txt b/dev/_sources/auto_examples/workflows/plot_simulate_gamma.rst.txt
@@ -478,7 +478,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (2 minutes 3.333 seconds)
+   **Total running time of the script:** (2 minutes 10.143 seconds)
 
 
 .. _sphx_glr_download_auto_examples_workflows_plot_simulate_gamma.py: