Generally you need a python environment with jupyter notebooks installed. We plan to provide a requirements file soon so you can install all dependencies via pip install -r requirements.txt
.
Alternatively, you can install docker
and docker-compose
and run the notebooks in a dockerfile.
- install docker for ubuntu or mac (or any other distribution referenced on the pages).
- install docker-compose
Compile and run the image (type the commands in a commandline/shell)
docker-compose build notebook
docker-compose up notebook
Linux users will probably need to usesudo
.
Once you started the docker container, open your brower and type in http://localhost:8888 . All notebooks will be mapped to local lectures
directory so you have your changes on your local computer.
When you contribute a new notebook, we would like to have a clean version in the repository. You can install a tool that strips the notebook before commiting:
pip install nbstripout
- Install the pre-commit hook in the open-comp-neuro directory:
nbstripout --install