Skip to content

Commit 098de5c

Browse files
committed
update README
1 parent 3866dd7 commit 098de5c

1 file changed

Lines changed: 25 additions & 24 deletions

File tree

README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,43 @@
11
[![GS-Frame](https://img.shields.io/badge/github-GeoStat_Framework-468a88?logo=github&style=flat)](https://github.com/GeoStat-Framework)
22
[![Gitter](https://badges.gitter.im/GeoStat-Examples/community.svg)](https://gitter.im/GeoStat-Examples/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
33

4-
# Template
4+
# Finding a temperature trend in DWD data: regression vs. universal kriging
55

6-
This is a template for an example repository.
6+
In this example we are going to interpolate temperature data from the
7+
german weather service (DWD) downlaoded through the python package
8+
[wetterdienst](https://github.com/earthobservations/wetterdienst).
79

8-
You can create a new example by simply clicking on "Use this template".
9-
10-
The included example is showing the generation of a conditioned random field ensemble
11-
in 1D taken from [GSTools](https://geostat-framework.readthedocs.io/projects/gstools/en/stable/examples/06_conditioned_fields/00_condition_ensemble.html#sphx-glr-examples-06-conditioned-fields-00-condition-ensemble-py).
10+
In order to find a north-south trend in the data we will compare results from
11+
regression and universal kriging provided by GSTools.
1212

1313

1414
## Structure
1515

16-
Please try to organize your example in the given Structure
17-
- `data/` - here you should place your input data
18-
- `src/` - here you should place your python scripts
19-
- `results/` - here your computed results and plots should be stored
20-
- `README.md` - please describe your example in the readme, potentially showing results
21-
- `LICENSE` - the default license is MIT, you can use another one if wanted
16+
The workflow is organized by the following structure:
17+
- `data/` - downloaded temperature data and german border line
18+
- `src/`
19+
- `00_data_download.py` - downloading routines
20+
- `01_dwd_krige.py` - interpolation and comparison plot generation
21+
- `results/` - all produced results
2222

2323

2424
## Python environment
2525

26-
To make the example reproducible, it would be a good practice to provide one of
27-
the following files:
28-
- `requirements.txt` - requirements for [pip](https://pip.pypa.io/en/stable/user_guide/#requirements-files) to install all needed packages
29-
- `spec-file.txt` - specification file to create the original [conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#building-identical-conda-environments)
30-
31-
32-
## Workflow
26+
Main Python dependencies are stored in `requirements.txt`:
3327

34-
After finalizing your work, you should tag the repository with a version like `v1.0`.
28+
```
29+
gstools==1.3.1
30+
matplotlib
31+
cartopy==0.18.0
32+
geopandas==0.8.1
33+
wetterdienst==0.13.0
34+
```
3535

36-
Then, a [Zenodo](https://zenodo.org/) release will be created, so you can cite the repository in you publication.
36+
You can install them with `pip` (potentially in a virtual environment):
3737

38-
Please keep your `master` branch in line with the latest release.
39-
For further development use the `develop` branch and update `master` with pull-requests.
38+
```bash
39+
pip install -r requirements.txt
40+
```
4041

4142

4243
## Contact
@@ -46,4 +47,4 @@ You can contact us via <info@geostat-framework.org>.
4647

4748
## License
4849

49-
MIT © 2020
50+
MIT © 2021

0 commit comments

Comments
 (0)