Skip to content

Commit

Permalink
doc updates [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Circle Ci committed Oct 4, 2023
1 parent 1c6f010 commit 953fed0
Show file tree
Hide file tree
Showing 32 changed files with 17,019 additions and 16,951 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 3400e427391bcf9e9b6d3ab727e445a1
config: 87a9a1e52147485a65cb0962c33f080c
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion dev/_sources/auto_examples/howto/plot_connectivity.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ the aggregate current dipole.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 24.723 seconds)
**Total running time of the script:** (1 minutes 28.703 seconds)


.. _sphx_glr_download_auto_examples_howto_plot_connectivity.py:
Expand Down
4 changes: 2 additions & 2 deletions dev/_sources/auto_examples/howto/plot_firing_pattern.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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/tmpvx4621jy/spk_0.txt
Writing file /tmp/tmp1nmo9_x_/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'))
Expand Down Expand Up @@ -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 29.794 seconds)
**Total running time of the script:** (0 minutes 31.715 seconds)


.. _sphx_glr_download_auto_examples_howto_plot_firing_pattern.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ References
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 34.366 seconds)
**Total running time of the script:** (0 minutes 36.742 seconds)


.. _sphx_glr_download_auto_examples_howto_plot_record_extracellular_potentials.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 22.274 seconds)
**Total running time of the script:** (0 minutes 22.477 seconds)


.. _sphx_glr_download_auto_examples_howto_plot_simulate_mpi_backend.py:
Expand Down
10 changes: 5 additions & 5 deletions dev/_sources/auto_examples/howto/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**02:51.158** total execution time for 5 files **from auto_examples/howto**:
**02:59.638** total execution time for 5 files **from auto_examples/howto**:

.. container::

Expand All @@ -33,16 +33,16 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_howto_plot_connectivity.py` (``plot_connectivity.py``)
- 01:24.723
- 01:28.703
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_plot_record_extracellular_potentials.py` (``plot_record_extracellular_potentials.py``)
- 00:34.366
- 00:36.742
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_plot_firing_pattern.py` (``plot_firing_pattern.py``)
- 00:29.794
- 00:31.715
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_plot_simulate_mpi_backend.py` (``plot_simulate_mpi_backend.py``)
- 00:22.274
- 00:22.477
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_optimize_evoked.py` (``optimize_evoked.py``)
- 00:00.000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 0x7fe71ffbb3a0>
<hnn_core.dipole.Dipole object at 0x7f54a1825940>
Expand Down Expand Up @@ -326,7 +326,7 @@ References
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 38.427 seconds)
**Total running time of the script:** (1 minutes 37.557 seconds)


.. _sphx_glr_download_auto_examples_workflows_plot_simulate_alpha.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,7 @@ References
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (2 minutes 57.027 seconds)
**Total running time of the script:** (3 minutes 13.135 seconds)


.. _sphx_glr_download_auto_examples_workflows_plot_simulate_beta.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ References
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 1.029 seconds)
**Total running time of the script:** (1 minutes 6.497 seconds)


.. _sphx_glr_download_auto_examples_workflows_plot_simulate_evoked.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ References
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (2 minutes 5.647 seconds)
**Total running time of the script:** (2 minutes 5.218 seconds)


.. _sphx_glr_download_auto_examples_workflows_plot_simulate_gamma.py:
Expand Down

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions dev/_sources/auto_examples/workflows/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**08:31.046** total execution time for 5 files **from auto_examples/workflows**:
**09:01.660** total execution time for 5 files **from auto_examples/workflows**:

.. container::

Expand All @@ -33,17 +33,17 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_beta.py` (``plot_simulate_beta.py``)
- 02:57.027
- 03:13.135
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_gamma.py` (``plot_simulate_gamma.py``)
- 02:05.647
- 02:05.218
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_alpha.py` (``plot_simulate_alpha.py``)
- 01:38.427
- 01:37.557
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_evoked.py` (``plot_simulate_evoked.py``)
- 01:01.029
- 01:06.497
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_somato.py` (``plot_simulate_somato.py``)
- 00:48.915
- 00:59.254
- 0.0
20 changes: 10 additions & 10 deletions dev/_sources/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**11:22.204** total execution time for 10 files **from all galleries**:
**12:01.297** total execution time for 10 files **from all galleries**:

.. container::

Expand All @@ -33,31 +33,31 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_beta.py` (``../examples/workflows/plot_simulate_beta.py``)
- 02:57.027
- 03:13.135
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_gamma.py` (``../examples/workflows/plot_simulate_gamma.py``)
- 02:05.647
- 02:05.218
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_alpha.py` (``../examples/workflows/plot_simulate_alpha.py``)
- 01:38.427
- 01:37.557
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_plot_connectivity.py` (``../examples/howto/plot_connectivity.py``)
- 01:24.723
- 01:28.703
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_evoked.py` (``../examples/workflows/plot_simulate_evoked.py``)
- 01:01.029
- 01:06.497
- 0.0
* - :ref:`sphx_glr_auto_examples_workflows_plot_simulate_somato.py` (``../examples/workflows/plot_simulate_somato.py``)
- 00:48.915
- 00:59.254
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_plot_record_extracellular_potentials.py` (``../examples/howto/plot_record_extracellular_potentials.py``)
- 00:34.366
- 00:36.742
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_plot_firing_pattern.py` (``../examples/howto/plot_firing_pattern.py``)
- 00:29.794
- 00:31.715
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_plot_simulate_mpi_backend.py` (``../examples/howto/plot_simulate_mpi_backend.py``)
- 00:22.274
- 00:22.477
- 0.0
* - :ref:`sphx_glr_auto_examples_howto_optimize_evoked.py` (``../examples/howto/optimize_evoked.py``)
- 00:00.000
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/howto/plot_connectivity.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@
<img src="../../_images/sphx_glr_plot_connectivity_008.png" srcset="../../_images/sphx_glr_plot_connectivity_008.png" alt="Aggregate (L2 + L5)" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>&lt;Figure size 600x600 with 2 Axes&gt;
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 24.723 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 28.703 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-howto-plot-connectivity-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/howto/plot_connectivity.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo.svg" width="150px" /></a>
Expand Down
4 changes: 2 additions & 2 deletions dev/auto_examples/howto/plot_firing_pattern.html
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@
</ul>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>/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, &#39;spk_%d.txt&#39;))
Writing file /tmp/tmpvx4621jy/spk_0.txt
Writing file /tmp/tmp1nmo9_x_/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, &#39;spk_*.txt&#39;))

Expand Down Expand Up @@ -334,7 +334,7 @@
<img src="../../_images/sphx_glr_plot_firing_pattern_004.png" srcset="../../_images/sphx_glr_plot_firing_pattern_004.png" alt="plot firing pattern" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>&lt;Figure size 500x700 with 3 Axes&gt;
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 29.794 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 31.715 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-howto-plot-firing-pattern-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/howto/plot_firing_pattern.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo.svg" width="150px" /></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
potential? Neuron 72, 847–858 (2011).</p>
</aside>
</aside>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 34.366 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 36.742 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-howto-plot-record-extracellular-potentials-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/howto/plot_record_extracellular_potentials.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo.svg" width="150px" /></a>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/howto/plot_simulate_mpi_backend.html
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@
&lt;Figure size 640x480 with 1 Axes&gt;
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 22.274 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 22.477 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-howto-plot-simulate-mpi-backend-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/howto/plot_simulate_mpi_backend.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo.svg" width="150px" /></a>
Expand Down
10 changes: 5 additions & 5 deletions dev/auto_examples/howto/sg_execution_times.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@

<section id="computation-times">
<span id="sphx-glr-auto-examples-howto-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Permalink to this heading"></a></h1>
<p><strong>02:51.158</strong> total execution time for 5 files <strong>from auto_examples/howto</strong>:</p>
<p><strong>02:59.638</strong> total execution time for 5 files <strong>from auto_examples/howto</strong>:</p>
<div class="docutils container">
<style scoped>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
Expand All @@ -166,19 +166,19 @@
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="plot_connectivity.html#sphx-glr-auto-examples-howto-plot-connectivity-py"><span class="std std-ref">03. Modifying local connectivity</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_connectivity.py</span></code>)</p></td>
<td><p>01:24.723</p></td>
<td><p>01:28.703</p></td>
<td><p>0.0</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot_record_extracellular_potentials.html#sphx-glr-auto-examples-howto-plot-record-extracellular-potentials-py"><span class="std std-ref">02. Record extracellular potentials</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_record_extracellular_potentials.py</span></code>)</p></td>
<td><p>00:34.366</p></td>
<td><p>00:36.742</p></td>
<td><p>0.0</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot_firing_pattern.html#sphx-glr-auto-examples-howto-plot-firing-pattern-py"><span class="std std-ref">01. Plot firing pattern</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_firing_pattern.py</span></code>)</p></td>
<td><p>00:29.794</p></td>
<td><p>00:31.715</p></td>
<td><p>0.0</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot_simulate_mpi_backend.html#sphx-glr-auto-examples-howto-plot-simulate-mpi-backend-py"><span class="std std-ref">04. Use MPI backend for parallelization</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_simulate_mpi_backend.py</span></code>)</p></td>
<td><p>00:22.274</p></td>
<td><p>00:22.477</p></td>
<td><p>0.0</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="optimize_evoked.html#sphx-glr-auto-examples-howto-optimize-evoked-py"><span class="std std-ref">05. Optimize simulated evoked response parameters</span></a> (<code class="docutils literal notranslate"><span class="pre">optimize_evoked.py</span></code>)</p></td>
Expand Down
4 changes: 2 additions & 2 deletions dev/auto_examples/workflows/plot_simulate_alpha.html
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@
Trial 1: 290.0 ms...
Trial 1: 300.0 ms...

&lt;hnn_core.dipole.Dipole object at 0x7fe71ffbb3a0&gt;
&lt;hnn_core.dipole.Dipole object at 0x7f54a1825940&gt;
</pre></div>
</div>
<p>Prior to plotting, we can choose to smooth the dipole waveform (note that the
Expand Down Expand Up @@ -356,7 +356,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
sensory-evoked responses. J. Neurophysiol. 102, 3554–3572 (2009).</p>
</aside>
</aside>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 38.427 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 37.557 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-workflows-plot-simulate-alpha-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/workflows/plot_simulate_alpha.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo1.svg" width="150px" /></a>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/workflows/plot_simulate_beta.html
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
53(5), 735–746. <a class="reference external" href="https://doi.org/10.1016/j.neuron.2007.02.012">https://doi.org/10.1016/j.neuron.2007.02.012</a></p>
</aside>
</aside>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (2 minutes 57.027 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (3 minutes 13.135 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-workflows-plot-simulate-beta-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/workflows/plot_simulate_beta.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo1.svg" width="150px" /></a>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/workflows/plot_simulate_evoked.html
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
modeling study.” Journal of Neuroscience 27.40 (2007): 10751-10764.</p>
</aside>
</aside>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 1.029 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 6.497 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-workflows-plot-simulate-evoked-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/workflows/plot_simulate_evoked.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo1.svg" width="150px" /></a>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/workflows/plot_simulate_gamma.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
neuroscience (2013)</p>
</aside>
</aside>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (2 minutes 5.647 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (2 minutes 5.218 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-workflows-plot-simulate-gamma-py">
<div class="binder-badge docutils container">
<a class="reference external image-reference" href="https://mybinder.org/v2/gh/jonescompneurolab/hnn-core/gh-pages?filepath=dev/notebooks/auto_examples/workflows/plot_simulate_gamma.ipynb"><img alt="Launch binder" src="../../_images/binder_badge_logo1.svg" width="150px" /></a>
Expand Down
Loading

0 comments on commit 953fed0

Please sign in to comment.