Skip to content
Snippets Groups Projects
Commit 98ddccd6 authored by Solange Emmenegger's avatar Solange Emmenegger
Browse files

Added Readme

parent 241ba43d
No related branches found
No related tags found
No related merge requests found
...@@ -3,36 +3,57 @@ ...@@ -3,36 +3,57 @@
## Introduction ## Introduction
This is a Renku project - basically a git repository with some This is a Renku project - basically a git repository with some
bells and whistles. You'll find we have already created some bells and whistles. This is how to do the exercises on Renku.
useful things like `data` and `notebooks` directories and
a `Dockerfile`.
## Working with the project ## Fork the Project
The simplest way to start your project is right from the Renku 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.
platform - just click on the `Environments` tab and start a new session.
This will start an interactive environment right in your browser.
To work with the project anywhere outside the Renku platform, ![Alt text](img/fork.png "Where to find the Fork Button")
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. ![Alt text](img/fork_prompt.png )
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 ![Alt text](img/your_project.png )
project there is currently only one option, which specifies
the default type of environment to open, in this case `/lab` for ## Starting a Session
JupyterLab. You may also choose `/tree` to get to the "classic" Jupyter
interface. Click on the project and go to the Sessions tab, and click on the "New Session button". You should then see the below screen.
![Alt text](img/new_session.png )
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:
![Alt text](img/session_overview.png )
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.
![Alt text](img/folder_structure.png )
To save your work you can click on the save button from time to time.
![Alt text](img/saving.png )
Then in the menu bar on the left, click on the third symbol (git-symbol).
![Alt text](img/git_interface.png )
Then click on the plus, next to the "Changed" tab, like this your changes are added in the repository.
![Alt text](img/add_change.png )
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.
![Alt text](img/commit.png )
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!
img/add_change.png

12.3 KiB

img/commit.png

15.1 KiB

img/folder_structure.png

27.4 KiB

img/fork.png

41.4 KiB

img/fork_prompt.png

87.5 KiB

img/git_interface.png

18.1 KiB

img/saving.png

23.7 KiB

img/session_overview.png

37 KiB

img/your_project.png

22.4 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment