# __PROJECT_NAME__

> Kurze Projektbeschreibung hier eintragen.

## Projektstruktur

    __PROJECT_NAME__/
      bin/                      Skripte zur Umgebungsverwaltung
        setenv.bat/.sh          Umgebungsvariablen setzen
        install_py.bat/.sh      venv erstellen + pip install
        activate_venv.bat/.sh   venv aktivieren
        get_cmd.bat/.sh         Shell mit Umgebung oeffnen
      cfg/                      Konfigurationsdateien (INI/JSON)
      data/                     Eingabedaten (nicht im Git)
      doc/                      Dokumentation
      examples/                 Beispieldateien
      lib/                      Python-Quellcode / Bibliothek
      log/                      Log-Dateien (nicht im Git)
      results/                  Ergebnisse / Ausgaben (nicht im Git)
      tests/                    Unit Tests
      .gitignore
      LICENSE
      README.md
      requirements.txt

## Umgebungsvariablen

| Variable       | Beschreibung              |
|----------------|---------------------------|
| `PROJECT`      | Wurzelverzeichnis          |
| `PV_BIN`       | Skriptverzeichnis          |
| `PV_LIB`       | Python-Quellcode           |
| `PV_CFG`       | Konfigurationsdateien      |
| `PV_DATA`      | Eingabedaten               |
| `PV_LOG`       | Log-Dateien                |
| `PV_RESULTS`   | Ergebnisse                 |
| `PV_EXAMPLES`  | Beispieldateien            |
| `PYTHONPATH`   | Erweitert um `PV_LIB`      |

## Installation

### Voraussetzungen

- Python 3.10 oder hoeher

### Setup (Windows)

    bin\install_py.bat

### Setup (Linux / macOS)

    bash bin/install_py.sh

## Nutzung

### Umgebung setzen

    bin\setenv.bat              # Windows
    source bin/setenv.sh        # Linux / macOS

### Shell mit gesetzten Variablen oeffnen

    bin\get_cmd.bat             # Windows
    source bin/get_cmd.sh       # Linux / macOS

### venv aktivieren

    bin\activate_venv.bat       # Windows
    source bin/activate_venv.sh # Linux / macOS

## Lizenz

MIT License - siehe LICENSE

## Autor

Michael Stangl (GitHub: mistamichael)