Update documentation

int-brain-lab · Jul 16, 2024 · 6ce69cd · 6ce69cd
1 parent 96a60c7
commit 6ce69cd
Show file tree

Hide file tree

Showing 478 changed files with 2,365 additions and 1,744 deletions.
diff --git a/010_api_reference.html b/010_api_reference.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/02_installation.html b/02_installation.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/06_examples.html b/06_examples.html
@@ -57,7 +57,7 @@
 <li class="toctree-l1"><a class="reference internal" href="public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/09_contribution.html b/09_contribution.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.atlas.html b/_autosummary/brainbox.atlas.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.behavior.dlc.html b/_autosummary/brainbox.behavior.dlc.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>
@@ -164,12 +164,7 @@
 <td><p>Estimates pupil diameter by taking median of different computations.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.dlc.get_smooth_pupil_diameter" title="brainbox.behavior.dlc.get_smooth_pupil_diameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_smooth_pupil_diameter</span></code></a></p></td>
-<td><p><dl class="field-list simple">
-<dt class="field-odd">param diameter_raw<span class="colon">:</span></dt>
-<dd class="field-odd"><p>np.array, raw pupil diameters, calculated from (thresholded) dlc traces</p>
-</dd>
-</dl>
-</p></td>
+<td><p></p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#brainbox.behavior.dlc.get_sniffs" title="brainbox.behavior.dlc.get_sniffs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_sniffs</span></code></a></p></td>
 <td><p>Compute sniff times from the nose tip</p></td>

diff --git a/_autosummary/brainbox.behavior.html b/_autosummary/brainbox.behavior.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.behavior.training.TRIALS_KEYS.html b/_autosummary/brainbox.behavior.training.TRIALS_KEYS.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.behavior.training.html b/_autosummary/brainbox.behavior.training.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.behavior.wheel.html b/_autosummary/brainbox.behavior.wheel.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.core.html b/_autosummary/brainbox.core.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.ephys_plots.html b/_autosummary/brainbox.ephys_plots.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.html b/_autosummary/brainbox.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.io.html b/_autosummary/brainbox.io.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>

diff --git a/_autosummary/brainbox.io.one.html b/_autosummary/brainbox.io.one.html
@@ -59,7 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/public_introduction.html">Publicly available IBL data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_behavior.html">Data Release - Behavior</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/data_release_pilot.html">Data Release - Pilot Dataset</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys Paper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_repro_ephys.html">Data Release - Reproducible Ephys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_brainwidemap.html">Data Release - Brain Wide Map</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_release_spikesorting_benchmarks.html">Data Release - Spike sorting benchmark datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../public_docs/information_contact.html">Information and troubleshooting</a></li>