fabiansinz / pydocker-template

Template to start a project with python, docker, datajoint, and jupyter notebook.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Requirements

Run it without docker

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.

Run it via docker

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 use sudo.

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.

Good practices for contributing

Clean notebooks

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

About

Template to start a project with python, docker, datajoint, and jupyter notebook.

License:MIT License


Languages

Language:Jupyter Notebook 82.6%Language:Python 14.2%Language:Shell 3.2%