Skip to content

Commit

Permalink
Add CICADA to the community tools list (#100)
Browse files Browse the repository at this point in the history
* Add Cicada to the community tools list
* Update spelling error in README
  • Loading branch information
oruebel committed Jul 18, 2023
1 parent bf0b256 commit 4836055
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To contribute a new tool to the list of analysis, visualization and data managem
**Step 3:** Update the ``<my*>`` parts and add a brief description of your tool as well as an image for your tool.

**Step 4:** You may add additional sections as approbriate to the page, e.g., to describe tool features, usage, or installation. In particular, also consider adding a section on ``Compatability with NWB`` to describe how your tools integrate with NWB (e.g., does your tool support read/write/update of specific neurodata_types in NWB and does your tool require any extensions).
**Step 4:** You may add additional sections as appropriate to the page, e.g., to describe tool features, usage, or installation. In particular, also consider adding a section on ``Compatability with NWB`` to describe how your tools integrate with NWB (e.g., does your tool support read/write/update of specific neurodata_types in NWB and does your tool require any extensions).

**Step 5:** In ``docs/source/tools/tools_home.rst`` Add your tool to the toctree at the top of the page to ensure the tool gets listed in the main menu

Expand Down
14 changes: 14 additions & 0 deletions docs/source/tools/cicada/cicada.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _analysistools-cicada:

CICADA
------

.. short_description_start
:ref:`analysistools-cicada` is a Python pipeline providing a graphical user interface (GUI) that allows the user to visualize, explore and analyze Calcium Imaging data contained in NWB files. :bdg-link-primary:`Docs <https://pycicada.readthedocs.io/en/latest/tutorial.html>` :bdg-link-primary:`Source <https://gitlab.com/cossartlab/cicada/>` :bdg-link-primary:`Video Demo <https://www.youtube.com/watch?v=xgf2RmrGVx0>` :bdg-link-primary:`Cite <https://elifesciences.org/articles/78116#s4-5-6>`

.. short_description_end
.. image:: cicada_screenshot.png
:class: align-left
:width: 400
Binary file added docs/source/tools/cicada/cicada_screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions docs/source/tools/tools_home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Analysis and Visualization Tools
suite2p/suite2p
ciatah/ciatah
extract/extract
cicada/cicada
mies/mies
patchview/patchview
deeplabcut/deeplabcut
Expand Down Expand Up @@ -221,6 +222,22 @@ Optical Physiology Tools
:start-after: .. short_description_start
:end-before: .. short_description_end

.. raw:: html

<br />
<br />
<br />


.. image:: cicada/cicada_screenshot.png
:class: align-left
:width: 180

.. include:: cicada/cicada.rst
:start-after: .. short_description_start
:end-before: .. short_description_end



.. raw:: html

Expand Down

0 comments on commit 4836055

Please sign in to comment.