Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Sep 17, 2023
1 parent a92895d commit 6c6d085
Show file tree
Hide file tree
Showing 45 changed files with 10,136 additions and 6,282 deletions.
Binary file added _images/commutator-front-thin.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions _sources/coax-commutator/developer-guide/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ Developer Guide
-------------------------------------------------

.. attention:: This section provides information on hacking a commutator or
building your own. For an overview of Open Ephys Commutators, visit the
:ref:`oec`. For instructions on how to use the Coaxial Commutator, visit
building your own. For instructions on how to use the Coaxial Commutator, visit
the Coaxial Commutator :ref:`quick_start` Guide and :ref:`user_guide`.

Design Files
Expand Down
86 changes: 13 additions & 73 deletions _sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,82 +1,22 @@
.. _oec:

Open Ephys Commutators
*************************************************
.. title:: Home

.. toctree::
:hidden:
.. image:: _static/images/commutator-front-thin.jpg
:alt: Commutator front image

|
coax-commutator/index
spi-commutator/index
**Open Ephys Commutators** provide nearly torque-free tether management for freely moving recordings. Inertial-measurement units (IMUs) or video-based pose-estimation methods (e.g. `DeepLabCut <https://github.com/DeepLabCut/DeepLabCut>`_ or `SLEAP <https://github.com/talmolab/sleap>`_) provide real-time measurements of animal orientation. Therefore, these technologies can be used to drive active commutation instead of relying on tether torque measurement, which is used in conventional active commutators. This permits the use of exceptionally thin tethers that promote natural animal behavior but are too flexible to be used with conventional commutators.

.. raw:: html
The **Coax Commutator** is compatible with `UCLA Miniscopes <https://open-ephys.org/miniscope-v4/miniscope-v4">`__ and `ONIX Headstages <https://open-ephys.github.io/onix-docs/Hardware%20Guide/Headstages/headstage-64/index.html">`__.

<div class="container">
<div class="row">
<div class="col-lg-3 col-md-3 col-sm-5 col-xs-5 m-0 p-0">
<img src="_static/images/commutator-front-thin.jpg" alt="Commutator front image">
</div>
<div class="col-lg-9 col-md-9 col-sm-7 col-xs-7 d-flex flex-column m-0 p-0">
<div class="card-body">
<p class="card-text">
Open-ephys commutators provide nearly <b>torque-free</b>
tether management for freely moving recordings.
Inertial-measurement units (IMUs) or video-based
pose-estimation methods (e.g. <a
href="https://github.com/DeepLabCut/DeepLabCut">
DeepLabCut </a> or <a
href="https://github.com/talmolab/sleap"> SLEAP
</a>) provide real-time measurements of animal orientation. Therefore, these technologies can be
used to drive active commutation instead of
relying on tether torque measurement, which is
used in conventional active commutators. This
permits the use of exceptionally thin tethers (such as these <a
href="https://open-ephys.github.io/onix-docs/Hardware%20Guide/Headstages/headstage-64/index.html">
micro coaxial cables </a>) that promote natural
animal behavior but are to flexible to be used with
conventional commutators.
<br>
<br>
Currently available Open Ephys Commutators include:
</p>
<ul class="simple">
<li><p><b>Coax Commutator:</b></p></li>
<p style="margin-left: 1em"> Compatible with <a href="https://open-ephys.org/miniscope-v4/miniscope-v4">UCLA miniscope headstages</a> and <a href="https://open-ephys.github.io/onix-docs/Hardware%20Guide/Headstages/headstage-64/index.html"> Open Ephys electrophysiology headstages</a> </p>
<li><p><b>SPI Commutator:</b></p></li>
<p style="margin-left: 1em"> Compatible with headstages that use SPI digital communication such as those from <a href="https://open-ephys.org/acquisition-system/low-profile-spi-headstage-64ch">Open Ephys</a> and <a href="https://intantech.com/pricing.html">Intan</a> </p>
</ul>
<p class="card-text">
To start using your your Open Ephys Commutator, please
refer to the guide that corresponds with your
device:
</p>
</div>
</div>
</div>
</div>
A commutator compatible with SPI cables is under active development.

.. raw:: html

<div class="container d-flex flex-wrap">
<div class="col" style="min-width: 20%">
<div class="card intro-card h-100 text-center shadow">
<a class="card-link" href="./coax-commutator/index.html">
<img class="card-img-top" src="_static/images/coax-cables-unlabeled.jpg">
<div class="card-body">
<p class="card-reference">Coax Commutator User Guide</p>
</div>
</a>
</div>
</div>
<div class="col" style="min-width: 20%">
<div class="card intro-card h-100 text-center shadow">
<a class="card-link" href="./spi-commutator/index.html">
<img class="card-img-top" src="_static/images/SPI-cable.jpg">
<div class="card-body">
<p class="card-reference">SPI Commutator User Guide</p>
</div>
</a>
</div>
</div>
</div>
.. toctree::
:hidden:
:maxdepth: 2
:titlesonly:

coax-commutator/index
55 changes: 26 additions & 29 deletions _static/basic.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 450px;
min-width: 360px;
max-width: 800px;
}

Expand All @@ -237,16 +237,6 @@ a.headerlink {
visibility: hidden;
}

a.brackets:before,
span.brackets > a:before{
content: "[";
}

a.brackets:after,
span.brackets > a:after {
content: "]";
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -335,12 +325,16 @@ p.sidebar-title {
font-weight: bold;
}

nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */

nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -379,13 +373,17 @@ div.body p.centered {

div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}

div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
Expand Down Expand Up @@ -428,10 +426,6 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}

table.footnote td, table.footnote th {
border: 0 !important;
}

th {
text-align: left;
padding-right: 5px;
Expand Down Expand Up @@ -615,19 +609,26 @@ ul.simple p {
margin-bottom: 0;
}

dl.footnote > dt,
dl.citation > dt {
aside.footnote > span,
div.citation > span {
float: left;
margin-right: 0.5em;
}

dl.footnote > dd,
dl.citation > dd {
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}

dl.footnote > dd:after,
dl.citation > dd:after {
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
Expand All @@ -644,10 +645,6 @@ dl.field-list > dt {
padding-right: 5px;
}

dl.field-list > dt:after {
content: ":";
}

dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
Expand Down
Loading

0 comments on commit 6c6d085

Please sign in to comment.