Commit 8a870662 authored by Fabian Neumann's avatar Fabian Neumann

update readme

parent c248d976
# Tutorial Structure
## Worksheets and Material
The tutorials include both, coding exercises and calculations done by hand.
There's a worksheet (`sheet-0X.pdf`) for every tutorial in `tutorial-X/worksheet`.
If the tutorial includes coding exercises (some tutorials have no coding exercises),
there are `jupyter notebooks` (`tutorial-X-task-Y.ipynb`) and data sources provided in `tutorial-X/notebooks`.
## Solutions
Solutions for coding exercises and calculations by hand are also included in the repository.
* See `tutorial-X/notebooks/tutorial-X-task-Y-solution.ipynb` for solutions to coding exercises.
* See `tutorial-X/worksheet/solution-0X.pdf` for solutions to calculations done by hand.
You may refer to them at any time, but (needless to say) it is best if you try without first.
# Python Tutorials
In the tutorials we will repeatedly work with the programming language Python. If you are unfamiliar with the language, you might find the following tutorials useful.
......@@ -37,8 +58,6 @@ https://git.scc.kit.edu/sp2668/esm_tutorials/-/archive/master/esm_tutorials-mast
**If you happen to come across this before the tutorials start,
you may already want to follow the installation instructions already to get started right away.**
We'll be using `Python` in the tutorials. If you are unfamiliar with `Python`, [this](http://introtopython.org/) is a great start, but a quick Google search on `Python` tutorials will give you millions of great alternatives.
We recommend using the package manager and environment management system `conda` to install the packages we need.
Install [`miniconda`](https://conda.io/docs/user-guide/install/index.html) (or Anaconda). For instructions for your operating system
......@@ -48,13 +67,13 @@ Create a new `conda` environment from the provided `environment.yaml` file with
Windows:
```bash
conda env create -f requirements.yml
conda env create -f environment.yaml
activate esm-tutorials
```
macOS and Linux:
```bash
conda env create -f requirements.yml
conda env create -f environment.yaml
conda activate esm-tutorials
```
......@@ -84,4 +103,4 @@ cd esm-tutorials
jupyter notebook
```
You should now be ready to do the tutorials :)
You should now be ready to do the tutorials :)
\ 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