Update documentation

int-brain-lab · Oct 24, 2023 · bf92983 · bf92983
1 parent eb850cd
commit bf92983
Show file tree

Hide file tree

Showing 330 changed files with 15,587 additions and 6,570 deletions.
diff --git a/010_api_reference.html b/010_api_reference.html
@@ -83,6 +83,7 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="_autosummary/ibllib.html">ibllib</a></li>
 <li class="toctree-l2"><a class="reference internal" href="_autosummary/brainbox.html">brainbox</a></li>
+<li class="toctree-l2"><a class="reference internal" href="_autosummary/iblatlas.html">iblatlas</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
@@ -130,6 +131,13 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
 </tr>
 </tbody>
 </table>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/iblatlas.html#module-iblatlas" title="iblatlas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">iblatlas</span></code></a></p></td>
+<td><p>A package for working with brain atlases.</p></td>
+</tr>
+</tbody>
+</table>
 </section>
 
 

diff --git a/_autosummary/brainbox.atlas.html b/_autosummary/brainbox.atlas.html
@@ -105,6 +105,7 @@
 <li class="toctree-l3"><a class="reference internal" href="brainbox.video.html">brainbox.video</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="iblatlas.html">iblatlas</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>

diff --git a/_autosummary/brainbox.behavior.dlc.html b/_autosummary/brainbox.behavior.dlc.html
@@ -108,6 +108,7 @@
 <li class="toctree-l3"><a class="reference internal" href="brainbox.video.html">brainbox.video</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="iblatlas.html">iblatlas</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>

diff --git a/_autosummary/brainbox.behavior.html b/_autosummary/brainbox.behavior.html
@@ -108,6 +108,7 @@
 <li class="toctree-l3"><a class="reference internal" href="brainbox.video.html">brainbox.video</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="iblatlas.html">iblatlas</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
@@ -151,7 +152,7 @@
 <td><p>(DEPRECATED) The psychofit toolbox contains tools to fit two-alternative psychometric data. The fitting is done using maximal likelihood estimation: one assumes that the responses of the subject are given by a binomial distribution whose mean is given by the psychometric function. The data can be expressed in fraction correct (from .5 to 1) or in fraction of one specific choice (from 0 to 1). To fit them you can use these functions:   - weibull50:          Weibull function from 0.5 to 1, with lapse rate   - weibull:            Weibull function from 0 to 1, with lapse rate   - erf_psycho:         erf function from 0 to 1, with lapse rate   - erf_psycho_2gammas: erf function from 0 to 1, with two lapse rates Functions in the toolbox are:   - mle_fit_psycho:     Maximumum likelihood fit of psychometric function   - neg_likelihood:      Negative likelihood of a psychometric function For more info, see:   - Examples:           Examples of use of psychofit toolbox Matteo Carandini, 2000-2015.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="brainbox.behavior.training.html#module-brainbox.behavior.training" title="brainbox.behavior.training"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior.training</span></code></a></p></td>
-<td><p></p></td>
+<td><p>Computing and testing IBL training status criteria.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="brainbox.behavior.wheel.html#module-brainbox.behavior.wheel" title="brainbox.behavior.wheel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior.wheel</span></code></a></p></td>
 <td><p>Set of functions to handle wheel data.</p></td>

diff --git a/_autosummary/brainbox.behavior.pyschofit.html b/_autosummary/brainbox.behavior.pyschofit.html
@@ -108,6 +108,7 @@
 <li class="toctree-l3"><a class="reference internal" href="brainbox.video.html">brainbox.video</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="iblatlas.html">iblatlas</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>

diff --git a/_autosummary/brainbox.behavior.training.TRIALS_KEYS.html b/_autosummary/brainbox.behavior.training.TRIALS_KEYS.html
@@ -0,0 +1,191 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>brainbox.behavior.training.TRIALS_KEYS &mdash; IBL Library  documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/style.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+        <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
+        <script src="../_static/copybutton.js?v=f281be69"></script>
+        <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="brainbox.behavior.wheel" href="brainbox.behavior.wheel.html" />
+    <link rel="prev" title="brainbox.behavior.training" href="brainbox.behavior.training.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            IBL Library
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">The Open Neurophysiology Environment</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/one_quickstart.html">ONE Quick Start</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://int-brain-lab.github.io/ONE/">Full documentation Website for ONE</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Public</span></p>
+<ul>
+<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_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>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Exploring IBL Data</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_structure.html">Get to know the datasets and folder structure</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/data_download.html">Download the public datasets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../loading_examples.html">Loading Data</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Miscellaneous</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../02_installation.html">Unified Environment</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../09_contribution.html">How to contribute</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Examples &amp; Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../atlas_examples.html">Atlas Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks_external/docs_wheel_moves.html">Working with wheel data</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../010_api_reference.html">API Reference</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="ibllib.html">ibllib</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="brainbox.html">brainbox</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="brainbox.atlas.html">brainbox.atlas</a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="brainbox.behavior.html">brainbox.behavior</a><ul class="current">
+<li class="toctree-l4"><a class="reference internal" href="brainbox.behavior.dlc.html">brainbox.behavior.dlc</a></li>
+<li class="toctree-l4"><a class="reference internal" href="brainbox.behavior.pyschofit.html">brainbox.behavior.pyschofit</a></li>
+<li class="toctree-l4 current"><a class="reference internal" href="brainbox.behavior.training.html">brainbox.behavior.training</a></li>
+<li class="toctree-l4"><a class="reference internal" href="brainbox.behavior.wheel.html">brainbox.behavior.wheel</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.core.html">brainbox.core</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.ephys_plots.html">brainbox.ephys_plots</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.io.html">brainbox.io</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.lfp.html">brainbox.lfp</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.metrics.html">brainbox.metrics</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.plot.html">brainbox.plot</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.plot_base.html">brainbox.plot_base</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.population.html">brainbox.population</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.processing.html">brainbox.processing</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.quality.html">brainbox.quality</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.singlecell.html">brainbox.singlecell</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.spike_features.html">brainbox.spike_features</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.task.html">brainbox.task</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.tests.html">brainbox.tests</a></li>
+<li class="toctree-l3"><a class="reference internal" href="brainbox.video.html">brainbox.video</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="iblatlas.html">iblatlas</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">IBL Library</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../010_api_reference.html">API Reference</a></li>
+          <li class="breadcrumb-item"><a href="brainbox.html">brainbox</a></li>
+          <li class="breadcrumb-item"><a href="brainbox.behavior.html">brainbox.behavior</a></li>
+          <li class="breadcrumb-item"><a href="brainbox.behavior.training.html">brainbox.behavior.training</a></li>
+      <li class="breadcrumb-item active">brainbox.behavior.training.TRIALS_KEYS</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="../_sources/_autosummary/brainbox.behavior.training.TRIALS_KEYS.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="brainbox-behavior-training-trials-keys">
+<h1>brainbox.behavior.training.TRIALS_KEYS<a class="headerlink" href="#brainbox-behavior-training-trials-keys" title="Link to this heading"></a></h1>
+<dl class="py data">
+<dt class="sig sig-object py" id="brainbox.behavior.training.TRIALS_KEYS">
+<span class="sig-name descname"><span class="pre">TRIALS_KEYS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['contrastLeft',</span> <span class="pre">'contrastRight',</span> <span class="pre">'feedbackType',</span> <span class="pre">'probabilityLeft',</span> <span class="pre">'choice',</span> <span class="pre">'response_times',</span> <span class="pre">'stimOn_times']</span></em><a class="headerlink" href="#brainbox.behavior.training.TRIALS_KEYS" title="Link to this definition"></a></dt>
+<dd><p>The required keys in the trials object for computing training status.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>list of str</p>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="brainbox.behavior.training.html" class="btn btn-neutral float-left" title="brainbox.behavior.training" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="brainbox.behavior.wheel.html" class="btn btn-neutral float-right" title="brainbox.behavior.wheel" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2020, International Brain Laboratory.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>