Skip to content

Commit a1df16c

Browse files
committed
correction of spelling mistakes and references
1 parent 2fb307e commit a1df16c

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

.python-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
esg_venv

docs/source/01_concepts.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Concepts
22
========
33

4-
This section explains how to apply the ESG framework and gives an overview of the basic technical concepts. For more in-depth information especially regarding the discussion of the approach, please refer to the published `research article <https://de.overleaf.com/project/6565c3491f8923df81a997ac>`__.
4+
This section explains how to apply the ESG framework and gives an overview of the basic technical concepts. For more in-depth information especially regarding the discussion of the approach, please refer to the published `research article <https://doi.org/10.48550/arXiv.2402.15230>`__.
55

66
Framework
77
---------

docs/source/02_example_service.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Example service implementation
22
==============================
3-
This section demonstrates a simple but fully functional implementation of a photovoltaic (PV) power gerneration forecast service. For more in-depth information about the individual components, please refer to the :doc:`01_concepts` section or the published `research article <https://de.overleaf.com/project/6565c3491f8923df81a997ac>`__.
3+
This section demonstrates a simple but fully functional implementation of a photovoltaic (PV) power gerneration forecast service. For more in-depth information about the individual components, please refer to the :doc:`01_concepts` section or the published `research article <https://doi.org/10.48550/arXiv.2402.15230>`__.
44

55
1. Preparation of the forecast or optimization code
66
---------------------------------------------------
@@ -66,7 +66,7 @@ parameters by invoking the forecasting or optimization code, as well as task sch
6666
.. literalinclude:: ../examples/basic_example/source/service/worker.py
6767
:pyobject: fit_parameters_task
6868

69-
The above code can be found in the `api.py <https://github.com/fzi-forschungszentrum-informatik/energy-service-generics/blob/main/docs/examples/basic_example/source/service/worker.py>`__ file.
69+
The above code can be found in the `worker.py <https://github.com/fzi-forschungszentrum-informatik/energy-service-generics/blob/main/docs/examples/basic_example/source/service/worker.py>`__ file.
7070

7171
4. Customization of the API component
7272
-------------------------------------
@@ -76,7 +76,7 @@ The implementation of the API component is available ready-to-use in the ESG fra
7676
:language: python
7777
:start-at: api =
7878

79-
The above code can be found in the `worker.py <https://github.com/fzi-forschungszentrum-informatik/energy-service-generics/blob/main/docs/examples/basic_example/source/service/api.py>`__ file.
79+
The above code can be found in the `api.py <https://github.com/fzi-forschungszentrum-informatik/energy-service-generics/blob/main/docs/examples/basic_example/source/service/api.py>`__ file.
8080

8181
5. Building docker images to derive functional services
8282
-------------------------------------------------------

docs/source/03_example_client.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section showcases two example client implementations for the basic example
44

55
Minimal client implementation
66
----------------------------------------------
7-
This minimal client implementation is to be executed on the same machine as the service. The service should be reachable via a localhost port. The client is implemented using a simple UNIX shell script and requires the additional packages **curl** and **jq**. The script below can be used to simulate a client that requests a photovoltaic power generation forecast from the basic example service. Note that this interaction with the `/fit-parameters/` endpoint is omitted in this example but would follow the same structure.
7+
This minimal client implementation is to be executed on the same machine as the service. The service should be reachable via a localhost port. The client is implemented using a simple UNIX shell script and requires the additional packages **curl** and **jq**. The script below can be used to simulate a client that requests a photovoltaic power generation forecast from the basic example service. Note that this interaction with the ``/fit-parameters/`` endpoint is omitted in this example but would follow the same structure.
88

99
.. literalinclude:: ../examples/minimial_client/source/client/main.sh
1010
:language: bash
@@ -18,6 +18,6 @@ The service integration in a production EMS will probably require a more sophist
1818
:language: python
1919
:start-at: import
2020

21-
It is recommended that the client developer specifies the data models themself in order to document the data structure of the downstream application, i.e. the EMS. This should reduce tedious debugging deep within the downstream application and produce the error right inside the client code. However, it is possible to fetch the data models autommatically from the service.
21+
It is recommended that the client developer specifies the data models themself in order to document the data structure of the downstream application, i.e. the EMS. This should reduce tedious debugging deep within the downstream application and produce the error right inside the client code. However, it is possible to fetch the data models automatically from the service.
2222

2323
It is to be noted, that the generic client provided by the ESG package can only be used in a python environment. Nevertheless, if the client code needs to be in a different language it should be possible to implement the logic rather quickly. `Swagger Codegen <https://swagger.io/tools/swagger-codegen/>`__ can help to partially automate the generation of the client program.

0 commit comments

Comments
 (0)