Openstef-reference

Warning

This repository will soon be archived as part of the OpenSTEF V3 deprecation. Please refer to OpenSTEF V4 for the latest OpenSTEF version which includes example deployments.

Reference implementation of the OpenSTEF stack. It includes all key functionality, e.g. the forecast engine, data storage and -models, the expert user dashboard!

Table of contents

• Installation
• Usage
• Tips and Tricks
• License
• Licenses third-party libraries
• Contributing
• Contact

Installation

Prerequisites

Both Docker and Docker compose have to be installed. It is recommended to follow the instruction of the corresponding page:

Install Docker

Follow the instruction on the Get Docker page: https://docs.docker.com/get-docker/

Install Docker Compose

Follow the instruction on the Install Docker Compose page: https://docs.docker.com/compose/install/

Usage

To start using the OpenSTEF reference stack use Docker Compose to bring up the whole stack:

$ sudo docker-compose up

Note: if you're running docker on a windows machine, issues might be caused by windows line endings. All line endings should be Unix!

Grafana

Open on http://localhost:3000 Log in using username admin and password admin

Set the mysql pasword (root) from withing the dashboard. Do this via Configuration > DataSources > tst_icarus (MySQL) > password.

Set the influx token pasword (mytoken) from withing the dashboard. Do this via Configuration > DataSources > InfluxDB-V2 > token.

To view the dash board navigate to the dashboard: Dashboards > Station forecasts.

Screenshot of the operational dashboard showing the key functionality of OpenSTEF. Dashboard documentation can be found here.

PhpMyAdmin

Open on http://localhost:8080 Log in using username root and password root

Influx UI

Open on http://localhost:8086 Log in using username myusername and password passwordpasswordpassword

Nginx

Open on http://localhost:8090

Mlflow

Open on http://localhost:8099

Running pipelines

In the root of the project run:

pip install -r requirements.txt

Run a training or forecast pipeline by running the corresponding python files in openstef_example_tasks from the root of this repository.

Tips and tricks

Enter running container

To enter the InfluxDB container run:

$ sudo docker exec -it openstef-influxdb /bin/bash

$ sudo docker exec -it openstef-nginx /bin/bash

Clear the volumes

Docker will try using previous volumes on runs. But sometimes you want to start fresh. Docker-compose offers the --renew-anon-volumes option for this purpose:

$ docker-compose up --renew-anon-volumes

License

This project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.

Licenses third-party libraries

This project includes third-party libraries, which are licensed under their own respective Open-Source licenses. SPDX-License-Identifier headers are used to show which license is applicable. The concerning license files can be found in the LICENSES directory.

Contributing

Please read CODE_OF_CONDUCT.md, CONTRIBUTING.md and PROJECT_GOVERNANACE.md for details on the process for submitting pull requests to us.

Contact

Please read SUPPORT.md for how to connect and get into contact with the OpenSTEF project