diff --git a/data/images/code_button.png b/data/images/code_button.png new file mode 100644 index 00000000..b65868fb Binary files /dev/null and b/data/images/code_button.png differ diff --git a/data/images/fork_button.png b/data/images/fork_button.png new file mode 100644 index 00000000..404ca714 Binary files /dev/null and b/data/images/fork_button.png differ diff --git a/data/images/virtual_navigation_schema.png b/data/images/virtual_navigation_schema.png new file mode 100644 index 00000000..66dd6256 Binary files /dev/null and b/data/images/virtual_navigation_schema.png differ diff --git a/docs/contribution.md b/docs/contribution.md index db00c2a9..082d8315 100644 --- a/docs/contribution.md +++ b/docs/contribution.md @@ -3,10 +3,10 @@ The OpenScope Databook is a community project. It aims to serve as a collection of contributed analyses from many different experts and to include a comprehensive set of useful and reproducible analyses. Contributors are added to the authors list and have an opportunity to share their figures, results, and datasets through their notebooks in the Databook. Together the project can grow and continue to shape the growing reproducible neuroscience ecosystem. ## Fork the OpenScope Databook -The Databook can be forked via the GitHub Web UI from the Databook's [GitHub repo](https://github.com/AllenInstitute/openscope_databook). Press the [fork button](https://github.com/AllenInstitute/openscope_databook/fork) or click this link. +The Databook can be forked via the GitHub Web UI from the Databook's [GitHub repo](https://github.com/AllenInstitute/openscope_databook). Press the [fork button](../data/images/fork_button.png) or click [this link](https://github.com/AllenInstitute/openscope_databook/fork). ## Initialize Locally -A local repo can be made by pressing the `code` button on the front page of the forked repo, and copying the HTTPS url. Then locally, run the command `git clone `. For more information on cloning GitHub repos, check out GitHub's [Cloning a Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) Page. +A local repo can be made by pressing the [code button](../data/images/code_button.png) on the front page of the forked repo, and copying the HTTPS url. Then locally, run the command `git clone `. For more information on cloning GitHub repos, check out GitHub's [Cloning a Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) Page. Then the environment must be set up. You may set up a conda environment if you don't want to interfere with your local environment. After installing conda, this can be done with the commands `conda create --name databook python=3.11` followed by `activate databook` (Windows) or `source activate databook` (Mac/Linux). Within or without the conda environment, the dependencies for the databook can be installed by navigating to the openscope_databook directory and running `pip install -e . --user`.