Add Renku session link in README.md

[cmdoret]

This PR proposes to add a "launch on renku" badge to the README.

Like binder, renku provides interactive jupyterlab sessions for user to try notebooks and code examples.
In addition, renku sessions are tied to a gitlab repository, which logged in users can fork to modify the code and save their changes.

The badge starts a session from a renku gitlab repository. When a session is started, it builds a docker image with Alphapept installed from the repository and gives you access to the alphapept streamlit interface.

For this particular example, I have setup a gitlab repository including alphapept as a dependency (in requirements.txt). I also included a dataset with some demo raw MS files (imported from Zenodo), as well as Alphapept results from processing these files. In the session, these files are available in the data/ folder. Users can then experiment with Alphapept, either by processing the raw files, or analyzing the results directly.

[straussmaximilian]

Hi,
I just checked this out and think it is extremely cool. I was quite surprised by how responsive it is (e.g., compared to binder).

Right now, the badge links to Session Tab. At first, I was a bit confused about what Renku does and found the missing info in the Overview tab. Does linking to the overview tab make more sense?

We recently held a workshop and wanted to use GoogleColab to demo the Python library, but Colab is stuck on Python3.7, so we abandoned this idea; so I could imagine this would be perfect for this when also having the option to launch a Jupyter Notebook Session. Is this, in principle, feasible, or are workshops with, e.g., 20+ users not an intended use-case?

For the docker integration: It looks like you got a working docker file. Do you think we can also use this to update the one on the AlphaPept repo (which I guess is untested / not working)

[cmdoret]

Hi @straussmaximilian

Thanks !

This makes sense I'll edit the badge link, and users can then start a session from the overview pane :)

Sure, we love it when people use Renku for teaching ! And yes, you could organize a workshop on Renku, we have a documentation page about teaching on Renku. Note that this page contains a link to a teaching announcement form. If you plan a workshop, it is better to announce it via this form to ensure we have enough resources available and don't schedule a maintenance at the same time.

The Dockerfile can be used on your machine, but you'd need to clone the renku repo and run the following command from the project's root, more information about running renku docker images locally here.

docker run --rm -ti -v ${PWD}:/work/${repoName} \
  --workdir /work/${repoName} -p 8888:8888 \
  ${imageName} jupyter lab --ip=0.0.0.0

You are of course free to use the Dockerfile, but in your case, it may be more convenient to have a separate docker image which is indepent of the Renku project.