AurelienGauffre/deepsleep

Add default config for Google Colab in CONTRIBUTING.md

Opened this issue · 5 comments

@AurelienGauffre you sent me the following:

!apt-get update
!apt-get install python3-venv
!pip install poetry

!git clone https://github.com/AurelienGauffre/DeepSleep
%cd DeepSleep

!poetry install
!poetry run pip install ipykernel

I'm not 100% sure we need the last line, would be good to test without. 😉

I can't make it work without it : Collab seems to require a manual install of ipykernel when dealing with virutal env as explained in the IPython doc .) "The Jupyter Notebook and other frontends automatically ensure that the IPython kernel is available. However, if you want to use a kernel with a different version of Python, or in a virtualenv or conda environment, you’ll need to install that manually."
As this module is not required in the project itself, I think we can let the installation of ipykernel directly in the test Jupyter.

Alright, let's keep it! So are you up to do the initialisation script? I'm thinking we just have to run something like !dev/setup_colab.sh at the top of our notebooks.

Ho but we have to clone the repo anyway... So would be:

!git clone https://github.com/AurelienGauffre/DeepSleep
%cd DeepSleep
!dev/setup_colab.sh

Project closed.