From 063696a805780c1f1e023046e95108d2ee90e5f4 Mon Sep 17 00:00:00 2001 From: Mark Robinson Date: Tue, 5 May 2020 20:49:45 +0000 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f3299e2..bf1d4d0 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,28 @@ This is the Renku project for the course [Bio334](https://studentservices.uzh.ch/uzh/anonym/vvz/index.html#/details/2019/004/SM/50628703) and just a note that this project was initially forked from [Laurent Gatto's course run at UC Louvain](https://renkulab.io/gitlab/laurent.gatto/wsbim1207). -## Working with the project +## Quick Renku instructions: -The simplest way to start your project is right from the Renku -platform - just click on the `Environments` tab and start a new session. -This will start an interactive environment right in your browser. +1. Go to [https://renkulab.io/](https://renkulab.io/). Click on the 'Login or Sign Up' button and make yourself an account if you do not have one, either via 'Register', a 'SWITCH edu-ID' or via a GitHub account. +2. Once logged in, go to the Bio334 "project" that Mark made: +[https://renkulab.io/projects/mark.robinson/bio334_spring2020/](https://renkulab.io/projects/mark.robinson/bio334_spring2020/) +3. Near the top right, click on the button to fork the project; this should bring up a box where you can modify the name (you don't need to) and you can click on the 'Fork' button, putting you on the landing page of your (new) project. +4. Click on the environments tab, then 'New' to open a new environment. Hopefully, it shows "Docker image available". For Python or command line work, select /lab; for R work, select, /rstudio (you can always switch back and forth). Leave the number of CPUs at 0.25 and Memory at 1G. Click 'Start environment'. This may take a couple minutes to boot up. +5. Once it's loaded, 'Connect' to the environment. This should open a new browser window with a web link that looks like: +https://renkulab.io/[snip]/bio334_spring2020-198a8763/rstudio/ +https://renkulab.io/[snip]/bio334_spring2020-198a8763/lab/ + +Note: you can always go back and forth between the `/rstudio` and `/lab` environments by modifying the end of web link, e.g., if you started in /rstudio, but want to move to /lab, you can remove "rstudio", type "lab" in its place and then press enter. + +Note: you can upload files from the local computer into your environment via the left tab of the /lab/ environment. + + +## Working with Renku Please see [the documentation](https://renku.readthedocs.io/en/latest/) for more details about Renku. + ## How the images were built So, the stack to build the images that work on Renku is a bit convoluted, so here is a description of the layers of layers that are involved. This is mostly left as a memento to remind myself how I did it. If I were to do it again, it would probably be worth organizing it all into one github repo. -- GitLab