Commit faf8ff9f authored by Christina Heinze-Deml's avatar Christina Heinze-Deml
Browse files

Update README.md

parent 79eeb8fb
# causality-course-ethz-2021 # causality-course-ethz
Code used in the causality course (401-4632-15) at ETH Zurich. This is a Renku project for the causality course taught at ETH Zurich during the spring semester.
A Renku project is basically a git repository with some
## Introduction
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. You'll find we have already created some
useful things like `data` and `notebooks` directories and useful things like `data` and `notebooks` directories and
a `Dockerfile`. a `Dockerfile`. The `notebooks` directory contains the Jupyter notebooks you'll work on during
the in-class exercise sessions.
## Working with the project ## Working with the project
The simplest way to start your project is right from the Renku The simplest way to start working is to fork this project. Once you have done this,
platform - just click on the `Environments` tab and start a new session. just click on the `Environments` tab and start a new session.
This will start an interactive environment right in your browser. This will start an interactive environment right in your browser.
To work with the project anywhere outside the Renku platform, To work with the project anywhere outside the Renku platform,
click the `Settings` tab where you will find the click the `Settings` tab where you will find the
git repo URLs - use `git` to clone the project on whichever machine you want. git repo URLs - use `git` to clone the project on whichever machine you want.
\ No newline at end of file
### Changing interactive environment dependencies
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`, and R packages to `install.R` (listed as, for example,
`install.packages("ggplot2")`), 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
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 `/rstudio`.
## 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!
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment