diff --git a/README.md b/README.md index e0e7540d966599680c63eecf57108e14e5bfa878..2fcba14f11990211f7a983b5bb681e0adf02f54a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,30 @@ # MLWorkflowInterface -This project develops a Jupyter/Dashboard-based user interface to control machine learning workflows "from a browser". It encapsulates triggering and monitoring of data preparation, training, and evaluation workflows, which can be launched by the user via a graphical user interface. +This project develops a Jupyter/Dashboard-based user interface for the DE_370C_FZJ - Destination Earth Use Case – Air Quality. -## Authors and acknowledgment -Sabine Schröder (s.schroeder_at_fz-juelich.de), Niklas Selke, Mohammed Elshambakey, Martin Schultz +The air quality use case of DestinE DE_370C comprises three model strategies, namely field forecasts with EURAD-IM, point forecasts with MLAir, and emission scenario calculations with EURAD-IM as well as the generation of evaluation plots. The user interface runs on a virtual machine in the cloud and triggers the execution of jobs on an HPC system. It is based on Python dash and the UNICORE software. + +## Installation instructions +After successful cloning of this repository, install all requirements from `requirements.txt` preferably in a virtual environment. You can use +``` +pip install -r requirements.txt +``` +to install all requirements at once. +Deploy with your favourite web server (for `nginx` start `app:server` with `gunicorn`-workers). + +## Authors +Sabine Schröder (s.schroeder_at_fz-juelich.de), Carl Burkert, Roman Romany, Max Lensing, Niklas Selke, Mohammed Elshambakey, Martin Schultz Jülich Supercomputing Centre (JSC) Forschungszentrum Jülich Wilhelm-Johnen-Str 52425 Jülich Germany +## Acknowledgment +We are pleased to acknowledge the valuable contributions and partnership of the two core user groups who have collaborated in the co-design process of our new Graphical User Interface (GUI): +The North Rhine-Westphalia Office of Nature, Environment and Consumer Protection (LANUV) +The German Environment Agency (UBA) +Their active engagement and insightful feedback have been instrumental in shaping a design solution that addresses their needs. + ## License This project is licensed under the open source MIT license. See LICENSE file. - -## Project status -Draft state.