diff --git a/README.md b/README.md index 1a226a88e387bc1d179b85e3026d77748b606e86..14d9d0ec2a5b05879aef77217ece2615290a6cef 100644 --- a/README.md +++ b/README.md @@ -3,36 +3,57 @@ ## Introduction This is a Renku project - basically a git repository with some -bells and whistles. You'll find we have already created some -useful things like `data` and `notebooks` directories and -a `Dockerfile`. +bells and whistles. This is how to do the exercises on Renku. -## Working with the project +## Fork the Project -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. +After Clicking on the ADML HSLU HS22 Project, you have a button "Fork" on the overview tab. When clicking on it you can duplicate this repository in your own namespace. -To work with the project anywhere outside the Renku platform, -click the `Settings` tab where you will find the -git repo URLs - use `git` to clone the project on whichever machine you want. + -### Changing interactive environment dependencies +Below you see the prompt you get when clicking on the Fork Button, you don't need to change anything just click on "Fork Project". (You won't get the title error as I do, because you don't have this repository yet.) -Initially we install a very minimal set of packages to keep the images small. -However, you can add python and conda packages in `requirements.txt` and -`environment.yml` to your heart's content. If you need more fine-grained -control over your environment, please see [the documentation](https://renku.readthedocs.io/en/latest/user/advanced_interfaces.html#dockerfile-modifications). + -## Project configuration +This has the advantage that you can save the changes to your notebook while working on it. When now going on your project page you have two "ADML HSLU HS22" project one with your namespace - this is the one you need to use from now on. +**Always use the ADML HSLU HS22 project with your name below** -Project options can be found in `.renku/renku.ini`. In this -project there is currently only one option, which specifies -the default type of environment to open, in this case `/lab` for -JupyterLab. You may also choose `/tree` to get to the "classic" Jupyter -interface. + + +## Starting a Session + +Click on the project and go to the Sessions tab, and click on the "New Session button". You should then see the below screen. + + + +When opening a session the first time after forking the project, you will encounter the Docker Image no available Error. This is not a problem, just click on building the branch image. It will now build your docker image. This can take some minutes. Afterwards you have a running session which looks like this: + + + +Click on the Open button and your Session will start. Or click on the three dots and choose open in new tab to have a better readability. Now you should see the folder structure as it is in the repository, open the notebook folder and you can see the notebooks adn open them by clicking on them. + + + +To save your work you can click on the save button from time to time. + + + +Then in the menu bar on the left, click on the third symbol (git-symbol). + + + +Then click on the plus, next to the "Changed" tab, like this your changes are added in the repository. + + + +In a last step, write a short description of what you did e.g. "Worked on Exercise 08B", and then click on the commit button. In this way, when opening a news session your changes will be restored. + + + +Happy Exercise Solving! + +## Advanced Use + +If you are familiar with git you can use the project as a normal git repository, open it on GitLab and even open Sessions from different commits. -## Moving forward -Once you feel at home with your project, we recommend that you replace -this README file with your own project documentation! Happy data wrangling! diff --git a/img/add_change.png b/img/add_change.png new file mode 100644 index 0000000000000000000000000000000000000000..e9057c098db53d9518d0ac6a416bfbc2867a4a5c Binary files /dev/null and b/img/add_change.png differ diff --git a/img/commit.png b/img/commit.png new file mode 100644 index 0000000000000000000000000000000000000000..52612c61ed52683ac997ff1a56dfa1158a4681ad Binary files /dev/null and b/img/commit.png differ diff --git a/img/folder_structure.png b/img/folder_structure.png new file mode 100644 index 0000000000000000000000000000000000000000..11f3c3841630804f4c87bda14e309e8ef540d33d Binary files /dev/null and b/img/folder_structure.png differ diff --git a/img/fork.png b/img/fork.png new file mode 100644 index 0000000000000000000000000000000000000000..4fcd5e458592fda2aa64cae00252289624b40b93 Binary files /dev/null and b/img/fork.png differ diff --git a/img/fork_prompt.png b/img/fork_prompt.png new file mode 100644 index 0000000000000000000000000000000000000000..d504c4ed7d3736b9a0a3c13d1b9ede331ea20207 Binary files /dev/null and b/img/fork_prompt.png differ diff --git a/img/git_interface.png b/img/git_interface.png new file mode 100644 index 0000000000000000000000000000000000000000..444eb06a17ae4d97afe944995ec4928dd40d402c Binary files /dev/null and b/img/git_interface.png differ diff --git a/img/saving.png b/img/saving.png new file mode 100644 index 0000000000000000000000000000000000000000..4239eb5f0b5db9d63dbd8372f3286882a8a3467c Binary files /dev/null and b/img/saving.png differ diff --git a/img/session_overview.png b/img/session_overview.png new file mode 100644 index 0000000000000000000000000000000000000000..0d581b8bcffa1b494eb25778b15dbf26918bb274 Binary files /dev/null and b/img/session_overview.png differ diff --git a/img/your_project.png b/img/your_project.png new file mode 100644 index 0000000000000000000000000000000000000000..5c89b639a71fc94865ed7a2507ee8113d3dbdb02 Binary files /dev/null and b/img/your_project.png differ