From ef2e7fdc0081488bb4a4c383b0a250e2b5bd75c0 Mon Sep 17 00:00:00 2001 From: Jonita Ruiter <148341618+JonitaRuiter@users.noreply.github.com> Date: Mon, 11 Dec 2023 10:21:03 +0100 Subject: [PATCH 1/2] Update and rename docs/concepts.rst to architecture_methodology_components.rst Changed the title, image and repositioned some of the text. Signed-off-by: Jonita Ruiter <148341618+JonitaRuiter@users.noreply.github.com> --- ...epts.rst => architecture_methodology_components.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) rename docs/concepts.rst => architecture_methodology_components.rst (96%) diff --git a/docs/concepts.rst b/architecture_methodology_components.rst similarity index 96% rename from docs/concepts.rst rename to architecture_methodology_components.rst index 4628cbf45..8c0aaa8d6 100644 --- a/docs/concepts.rst +++ b/architecture_methodology_components.rst @@ -4,7 +4,7 @@ .. _concepts: -Concepts + Architecture, Methodology, and Components ======== Understanding the architecture of OpenSTEF will help you gain insight on how to use this software package @@ -12,12 +12,12 @@ and better understand the rest of the documentation. Software architecture --------------------- +OpenSTEF is set up as a Python package that performs machine learning in order to forecast energy loads on the energy grid. -.. image:: https://user-images.githubusercontent.com/25053215/184536369-ed608e86-1ea8-4c16-8c6a-5eaeb145eedf.png - :width: 800 +.. image:: https://github.com/OpenSTEF/openstef/blob/a3abd78212248ee71fcfe182894c04e2df6dd1df/docs/software_arch.png + :width: 830 -OpenSTEF is set up as a Python package that performs machine learning in order to forecast energy loads on the energy grid. -It contains: +OpenSTEF contains: * **Prediction job**: input configuration for a task and/or pipeline (e.g. train an XGB model for a certain location). From c8b5d144d8d6fd7590682ddb7806df6ef4a5373d Mon Sep 17 00:00:00 2001 From: Jonita Ruiter <148341618+JonitaRuiter@users.noreply.github.com> Date: Tue, 12 Dec 2023 08:59:41 +0100 Subject: [PATCH 2/2] Add files via upload Signed-off-by: Jonita Ruiter <148341618+JonitaRuiter@users.noreply.github.com> --- docs/software_arch.png.license | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/software_arch.png.license diff --git a/docs/software_arch.png.license b/docs/software_arch.png.license new file mode 100644 index 000000000..57abd4c9e --- /dev/null +++ b/docs/software_arch.png.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project + +SPDX-License-Identifier: MPL-2.0