readme

1 files changed, 28 insertions, 6 deletions

diff --git a/Readme.md b/Readme.md
index 1cef027..034b61c 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,15 +1,37 @@
 # meteo toolbox
 
-DTKE_CON for convection forecast?
+This projects aims to provide a declarative frontend to create weather charts from a variety of sources.
+It mainly builds upon [MetPy](https://unidata.github.io/MetPy/latest/index.html),
+[Xarray](https://docs.xarray.dev) and [cfgrib](https://github.com/ecmwf/cfgrib).
 
-w_ctmax updraft velocity
+## Requirements
 
-## Sources
+This project depends on the [ecCodes](https://confluence.ecmwf.int/display/ECC/ecCodes+Home) tools,
+as well as some Python libraries.
 
-DWD OpenData: opendata.dwd.de
-ECMWF OpenData: https://www.ecmwf.int/en/forecasts/datasets/open-data
+The former can be installed with `pip install -r requirements.txt`.
 
-## 
+*ecCodes* is available in the [Arch User Repository](https://aur.archlinux.org/packages/eccodes).
+
+## Usage
+
+A configuration file is needed to run.
+It defines datasources, as well as plots to create.
+
+See the included `config.yaml` for an example configuration.
+
+To trigger chart generation, execute `run.py`.
+
+## Data Sources
+
+Currently, only the *DWD* models *ICON*, *ICON-EU* and *ICON-D2* are supported via the [DWD OpenData site](https://opendata.dwd.de/weather/nwp/).
+I plan to extend that to at least [ECMWF OpenData](https://www.ecmwf.int/en/forecasts/datasets/open-data)
+and the *University of Wyoming* [Atmospheric Science Radiosonde Archive](http://weather.uwyo.edu/upperair/bufrraob.shtml).
+
+It is my goal to make every plotter work with as many data sources as possible,
+to enable the parallel usage of as many datasources as possible.
+
+## notes
 
 https://matplotlib.org/3.1.1/gallery/color/colormap_reference.html
 https://unidata.github.io/MetPy/v1.0/api/generated/metpy.plots.ctables.html