From 59b6c227c0557fe2cfeabfa92f4b6fb7e48269ba Mon Sep 17 00:00:00 2001 From: Pat Gunn Date: Thu, 22 Feb 2024 14:56:12 -0500 Subject: [PATCH 1/2] Move and rephrase info on caiman central --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ec9f34b18..c4f67ace2 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ A Python toolbox for large-scale **Ca**lcium **Im**aging **An**alysis. CaImAn implements a set of essential methods required to analyze calcium and voltage imaging data. It provides fast and scalable algorithms for motion correction, source extraction, spike deconvolution, and registering neurons across multiple sessions. It is suitable for both two-photon and one-photon fluorescence microscopy data, and can be run in both offline and online modes. Documentation is [here](https://caiman.readthedocs.io/en/latest/). +Caiman Central +-------------- +- [Caiman Central](https://github.com/flatironinstitute/caiman_central) is the hub for sharing information about CaImAn. Information on quarterly community meetings, workshops, other events, and any other communications between the developers and the user community can be found there. + # Quick start :rocket: Follow these three steps to get started quickly, from installation to working through a demo notebook. If you do not already have conda installed, [you can find it here](https://docs.conda.io/en/latest/miniconda.html). There is a video walkthrough of the following steps [here](https://youtu.be/b63zAmKihIY?si=m7WleTwdU0rJup_2). @@ -63,7 +67,6 @@ A comprehensive list of references, where you can find detailed discussion of th In addition to the demos, there are many ways to learn more about Caiman and receive help: - [Online documentation](https://caiman.readthedocs.io/en/latest/) contains a lot of general information about Caiman, the parameters, how to interpret its outputs, and more. - [GitHub Discussions](https://github.com/flatironinstitute/CaImAn/discussions) is our preferred venue for users to ask for help. -- [Caiman Central](https://github.com/flatironinstitute/caiman_central) is our central hub for sharing information about CaImAn. Tune in there for updates about quarterly community meetings, workshops, etc. - The [Gitter forum](https://app.gitter.im/#/room/#agiovann_Constrained_NMF:gitter.im) is our old forum: we sometimes will ask people to join us there when something can best be solved in real time (e.g., installation problems). - If you have found a bug, we recommend searching the [issues at github](https://github.com/flatironinstitute/CaImAn/issues) and opening a new issue if you can't find the solution there. - If there is a feature you would like to see implemented, feel free to come chat at the above forums or open an issue at Github. From 09081abc654874e91eba0601dd509a09a2d10b5b Mon Sep 17 00:00:00 2001 From: Pat Gunn Date: Thu, 22 Feb 2024 15:33:14 -0500 Subject: [PATCH 2/2] Readme: change section header --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index c4f67ace2..06b627857 100644 --- a/README.md +++ b/README.md @@ -63,8 +63,7 @@ The main use cases and notebooks are listed in the following table: A comprehensive list of references, where you can find detailed discussion of the methods and their development, can be found [here](https://caiman.readthedocs.io/en/master/CaImAn_features_and_references.html#references). -# Questions, help, news -In addition to the demos, there are many ways to learn more about Caiman and receive help: +# How to get help - [Online documentation](https://caiman.readthedocs.io/en/latest/) contains a lot of general information about Caiman, the parameters, how to interpret its outputs, and more. - [GitHub Discussions](https://github.com/flatironinstitute/CaImAn/discussions) is our preferred venue for users to ask for help. - The [Gitter forum](https://app.gitter.im/#/room/#agiovann_Constrained_NMF:gitter.im) is our old forum: we sometimes will ask people to join us there when something can best be solved in real time (e.g., installation problems).