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 May 3, 2024
1 parent 75f0d3e commit ae30e87
Show file tree
Hide file tree
Showing 13 changed files with 18,277 additions and 18,262 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: 0c7c456b7bdf1c2624c92703bae212d0
config: 42b2b0f8aec905e31bf4e0b02544261f
tags: 645f666f9bcd5a90fca523b33c5a78b7
3 changes: 3 additions & 0 deletions dev/_sources/auto_examples/howto/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ tasks.

<div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open
.. raw:: html

Expand Down Expand Up @@ -100,6 +101,8 @@ tasks.
</div>


.. thumbnail-parent-div-close
.. raw:: html

</div>
Expand Down
2 changes: 1 addition & 1 deletion dev/_sources/auto_examples/howto/optimize_evoked.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
:class: sphx-glr-download-link-note

:ref:`Go to the end <sphx_glr_download_auto_examples_howto_optimize_evoked.py>`
to download the full example code or to run this example in your browser via Binder
to download the full example code. or to run this example in your browser via Binder

.. rst-class:: sphx-glr-example-title

Expand Down
9 changes: 9 additions & 0 deletions dev/_sources/auto_examples/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@

<div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open
.. thumbnail-parent-div-close
.. raw:: html

Expand Down Expand Up @@ -36,6 +39,7 @@ help users get started.

<div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open
.. raw:: html

Expand Down Expand Up @@ -122,6 +126,8 @@ help users get started.
</div>


.. thumbnail-parent-div-close
.. raw:: html

</div>
Expand All @@ -138,6 +144,7 @@ tasks.

<div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open
.. raw:: html

Expand Down Expand Up @@ -224,6 +231,8 @@ tasks.
</div>


.. thumbnail-parent-div-close
.. raw:: html

</div>
Expand Down
3 changes: 3 additions & 0 deletions dev/_sources/auto_examples/workflows/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ help users get started.

<div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open
.. raw:: html

Expand Down Expand Up @@ -112,6 +113,8 @@ help users get started.
</div>


.. thumbnail-parent-div-close
.. raw:: html

</div>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/howto/optimize_evoked.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
<div class="sphx-glr-download-link-note admonition note">
<p class="admonition-title">Note</p>
<p><a class="reference internal" href="#sphx-glr-download-auto-examples-howto-optimize-evoked-py"><span class="std std-ref">Go to the end</span></a>
to download the full example code or to run this example in your browser via Binder</p>
to download the full example code. or to run this example in your browser via Binder</p>
</div>
<section class="sphx-glr-example-title" id="optimize-simulated-evoked-response-parameters">
<span id="sphx-glr-auto-examples-howto-optimize-evoked-py"></span><h1>05. Optimize simulated evoked response parameters<a class="headerlink" href="#optimize-simulated-evoked-response-parameters" title="Permalink to this heading"></a></h1>
Expand Down
2 changes: 1 addition & 1 deletion dev/generated/hnn_core.dipole.Dipole.html
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ <h1>hnn_core.dipole.Dipole<a class="headerlink" href="#hnn-core-dipole-dipole" t
<dt class="sig sig-object py" id="hnn_core.dipole.Dipole.plot_tfr_morlet">
<span class="sig-name descname"><span class="pre">plot_tfr_morlet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">freqs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">7.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tmax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'agg'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">padding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'zeros'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'inferno'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colorbar</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colorbar_inside</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/hnn_core/dipole.html#Dipole.plot_tfr_morlet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hnn_core.dipole.Dipole.plot_tfr_morlet" title="Permalink to this definition"></a></dt>
<dd><p>Plot Morlet time-frequency representation of dipole time course</p>
<p>NB: Calls <a class="reference external" href="https://mne.tools/dev/generated/mne.time_frequency.tfr_array_morlet.html#mne.time_frequency.tfr_array_morlet" title="(in MNE v1.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tfr_array_morlet</span></code></a>, so <code class="docutils literal notranslate"><span class="pre">mne</span></code> must be
<p>NB: Calls <a class="reference external" href="https://mne.tools/dev/generated/mne.time_frequency.tfr_array_morlet.html#mne.time_frequency.tfr_array_morlet" title="(in MNE v1.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tfr_array_morlet</span></code></a>, so <code class="docutils literal notranslate"><span class="pre">mne</span></code> must be
installed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
8 changes: 4 additions & 4 deletions dev/gui/basic_gui_usage.html

Large diffs are not rendered by default.

12,950 changes: 6,475 additions & 6,475 deletions dev/gui/basic_gui_usage.ipynb

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions dev/gui/tutorial_erp.html

Large diffs are not rendered by default.

23,534 changes: 11,767 additions & 11,767 deletions dev/gui/tutorial_erp.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/whats_new.html
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ <h3>Changelog<a class="headerlink" href="#id15" title="Permalink to this heading
<li><p>Add methods for creating input drives and biases to network: <a class="reference internal" href="generated/hnn_core.Network.html#hnn_core.Network.add_evoked_drive" title="hnn_core.Network.add_evoked_drive"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_evoked_drive()</span></code></a>, <a class="reference internal" href="generated/hnn_core.Network.html#hnn_core.Network.add_poisson_drive" title="hnn_core.Network.add_poisson_drive"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_poisson_drive()</span></code></a>, <a class="reference internal" href="generated/hnn_core.Network.html#hnn_core.Network.add_bursty_drive" title="hnn_core.Network.add_bursty_drive"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_bursty_drive()</span></code></a> and <a class="reference internal" href="generated/hnn_core.Network.html#hnn_core.Network.add_tonic_bias" title="hnn_core.Network.add_tonic_bias"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_tonic_bias()</span></code></a>, by <a class="reference external" href="https://github.com/cjayb">Christopher Bailey</a> in <a class="reference external" href="https://github.com/jonescompneurolab/hnn-core/pull/221">#221</a></p></li>
<li><p>Add functions for plotting power spectral density (<a class="reference internal" href="generated/hnn_core.viz.plot_psd.html#hnn_core.viz.plot_psd" title="hnn_core.viz.plot_psd"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_psd()</span></code></a>) and Morlet time-frequency representations (<a class="reference internal" href="generated/hnn_core.viz.plot_tfr_morlet.html#hnn_core.viz.plot_tfr_morlet" title="hnn_core.viz.plot_tfr_morlet"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_tfr_morlet()</span></code></a>), by <a class="reference external" href="https://github.com/cjayb">Christopher Bailey</a> in <a class="reference external" href="https://github.com/jonescompneurolab/hnn-core/pull/264">#264</a></p></li>
<li><p>Add y-label units (nAm) to all visualisation functions involving dipole moments, by <a class="reference external" href="https://github.com/cjayb">Christopher Bailey</a> in <a class="reference external" href="https://github.com/jonescompneurolab/hnn-core/pull/264">#264</a></p></li>
<li><p>Add Savitzky-Golay filtering method <a class="reference internal" href="generated/hnn_core.dipole.Dipole.html#hnn_core.dipole.Dipole.savgol_filter" title="hnn_core.dipole.Dipole.savgol_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">savgol_filter()</span></code></a> to <code class="docutils literal notranslate"><span class="pre">Dipole</span></code>; copied from <code class="docutils literal notranslate"><span class="pre">mne-python</span></code> <a class="reference external" href="https://mne.tools/dev/generated/mne.Evoked.html#mne.Evoked.savgol_filter" title="(in MNE v1.7)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">savgol_filter()</span></code></a>, by <a class="reference external" href="https://github.com/cjayb">Christopher Bailey</a> in <a class="reference external" href="https://github.com/jonescompneurolab/hnn-core/pull/264">#264</a></p></li>
<li><p>Add Savitzky-Golay filtering method <a class="reference internal" href="generated/hnn_core.dipole.Dipole.html#hnn_core.dipole.Dipole.savgol_filter" title="hnn_core.dipole.Dipole.savgol_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">savgol_filter()</span></code></a> to <code class="docutils literal notranslate"><span class="pre">Dipole</span></code>; copied from <code class="docutils literal notranslate"><span class="pre">mne-python</span></code> <a class="reference external" href="https://mne.tools/dev/generated/mne.Evoked.html#mne.Evoked.savgol_filter" title="(in MNE v1.8)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">savgol_filter()</span></code></a>, by <a class="reference external" href="https://github.com/cjayb">Christopher Bailey</a> in <a class="reference external" href="https://github.com/jonescompneurolab/hnn-core/pull/264">#264</a></p></li>
</ul>
</section>
<section id="id35">
Expand Down

0 comments on commit ae30e87

Please sign in to comment.