Skip to content

Commit

Permalink
minor mods to contributing/readme
Browse files Browse the repository at this point in the history
  • Loading branch information
EricThomson committed Jun 1, 2023
1 parent f19c3f3 commit 208059b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ If you have downloaded Caiman for standard use, you probably installed it using
1. Fork and clone the caiman repository
Go to the [https://github.com/flatironinstitute/CaImAn](Caiman repo) and hit the `Fork` button at the top right of the page. You now have Caiman on your own GitHub repo. On your computer, in your conda prompt, go to a directory where you want Caiman to download, and clone your personal Caiman repo: `git clone https://github.com/<your-username>/CaImAn.git` where <your-username> is replaced by your github username.
2. Install in editable mode
In the previous step, you cloned your personal fork of Caiman. Detailed instructions for installing in development mode can be found on our [installation page](./docs/source/Installation.rst) for both [Windows](https://github.com/flatironinstitute/CaImAn/blob/master/docs/source/Installation.rst#installation-on-windows) and [Mac/Linux](https://github.com/flatironinstitute/CaImAn/blob/master/docs/source/Installation.rst#installation-on-macos-and-linux). While there are some differences, they both involve creating a conda environment from the `environment.yml` file you downloaded when you cloned the repo, activating that environment, and end with an "in place" install:
In the previous step, you cloned your personal fork of Caiman. Detailed instructions for installing in development mode can be found on our [installation page](./docs/source/Installation.rst) for both Windows and Mac/Linux. While there are some differences, they both involve creating a conda environment from the `environment.yml` file you downloaded when you cloned the repo, activating that environment, and end with an "in place" install:

pip install -e .

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Caiman should install easily on Linux, Mac, and Windows. If you run into problem


# Demo notebooks :page_with_curl:
Once you've gotten things set up, the best way to get started learning Caiman is to select the demo notebook that most closely matches your use case, and adapt it for your particular needs.
Once you've gotten things set up, the best way to get started learning Caiman is to select the demo notebook that most closely matches your use case, and adapt it for your particular needs.

In the demo notebooks folder within `caiman_data`, Caiman provides demo notebooks that demonstrate each of our main pipelines, from motion correction to online CNMF. The notebooks demonstrating the core algorithms, CNMF and CNMFE, are the best place to start: they have the most details that are used in the rest of the notebooks.

Expand Down

0 comments on commit 208059b

Please sign in to comment.