Skip to content

Commit

Permalink
Update Getting_Started.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
epnev authored Aug 16, 2019
1 parent 35c8726 commit 4d0fbfe
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/source/Getting_Started.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Getting Started with CaImAn
===========================

Demos
=====
-----

- Notebooks: The notebooks provide a simple and friendly way to get
into CaImAn and understand its main characteristics. They are located
Expand All @@ -22,7 +25,7 @@ Demos
still must be in the CaImAn directory.

Basic Structure
===============
---------------

We recently refactored the code to simplify the parameter setting and
usage of the various algorithms. The code now is based revolves around
Expand All @@ -46,7 +49,7 @@ To see examples of how these methods are used, please consult the demos.


Parameters
==========
-----------

CaImAn gives you access to a lot of parameters and lets you adapt the analysis to your data. Parameters are stored in
the ``params`` object in a set of dictionaries, sorted by the part of the analysis they are used in:
Expand Down Expand Up @@ -112,7 +115,7 @@ that manually registered ROIs already have a neuron-like shape.


Result Interpretation
=====================
----------------------

As mentioned above, the results of the analysis are stored within the
``estimates`` objects. The basic entries are the following:
Expand Down

0 comments on commit 4d0fbfe

Please sign in to comment.