Skip to content

Commit

Permalink
Adjust readme and dockerfile
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris committed Oct 5, 2024
1 parent 48c7a1f commit 01820c1
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ RUN DEBIAN_FRONTEND=noninteractive \
&& pip install --no-cache-dir -r requirements.txt \
&& apt remove ${APT_OPTS} gcc libhdf5-dev libmariadb-dev pkg-config

COPY config/example.config.json config/config.json

ENTRYPOINT []

CMD ["python", "flask_server.py"]
13 changes: 8 additions & 5 deletions README-DE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ https://meintechblog.de/2024/09/05/andreas-schmitz-joerg-installiert-mein-energi

Das Projekt erfordert Python 3.8 oder neuer.

## Konfiguration

Die Konfiguration erfolgt über `config.json`. Diese Datei muss im Ordner `config` erstellt werden.
Hierfür kann die `config.example.json` kopiert, bei Bedarf angepasst und dann in `config.json` umbenannt werden.

### Schnellanleitung

Unter Linux (Ubuntu/Debian):
Expand All @@ -27,8 +32,7 @@ Unter Macos (benötigt [Homebrew](https://brew.sh)):
brew install make
```

Nun `config.py` anpassen.
Anschließend kann der Server über `make run` gestartet werden.
Anschließend kann der Server über `make run` gestartet werden.
Eine vollständige Übersicht über die wichtigsten Kurzbefehle gibt `make help`.

### Ausführliche Anleitung
Expand Down Expand Up @@ -77,13 +81,12 @@ gefolgt von einem erneuten `pip install -r requirements.txt`.

## Nutzung

Einstellungen in `config.py` anpassen.
Um das System zu nutzen, führen Sie `flask_server.py` aus, damit wird der Server gestartet

Um das System zu nutzen, führen Sie `flask_server.py` aus, damit wird der Server gestartet.

```bash
./flask_server.py
```

## Klassen und Funktionalitäten

In diesem Projekt werden verschiedene Klassen verwendet, um die Komponenten eines Energiesystems zu simulieren und zu optimieren. Jede Klasse repräsentiert einen spezifischen Aspekt des Systems, wie nachfolgend beschrieben:
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ https://meintechblog.de/2024/09/05/andreas-schmitz-joerg-installiert-mein-energi

The project requires Python 3.8 or newer.

## Configuration

The configuration is done via `config.json`. This file must be created in the config folder. For this, the `config.example.json` can be copied, adjusted if necessary, and then renamed to `config.json`.

### Quick Start Guide

On Linux (Ubuntu/Debian):
Expand All @@ -27,7 +31,6 @@ On MacOS (requires [Homebrew](https://brew.sh)):
brew install make
```

Next, adjust `config.py`.
The server can then be started with `make run`. A full overview of the main shortcuts is given by `make help`.

### Detailed Instructions
Expand Down Expand Up @@ -72,7 +75,6 @@ Followed by a renewed `pip install -r requirements.txt`.

## Usage

Adjust `config.py`.
To use the system, run `flask_server.py`, which starts the server:

```bash
Expand Down

0 comments on commit 01820c1

Please sign in to comment.