added german versions

2024-10-18 15:21:58 +02:00 · 2024-10-18 15:21:58 +02:00 · 4696fdc701
commit 4696fdc701
parent 602d9bb422
5 changed files with 553 additions and 2 deletions
--- a/README_de.md
+++ b/README_de.md
@ -0,0 +1,223 @@
+# Leitfaden zur Datenanalyse-Struktur
+
+Willkommen zu diesem Leitfaden zur Projektstruktur! Dieser Leitfaden soll dir helfen zu verstehen, wie du Datenanalyseprojekte in Python effektiv strukturierst.
+
+## Inhaltsverzeichnis
+
+1. [Projektstruktur](#projektstruktur)
+   - [Trennung von Daten und Code](#trennung-von-daten-und-code)
+   - [Trennung von Abbildungen und Code](#trennung-von-abbildungen-und-code)
+2. [Versionskontrolle mit Git](#versionskontrolle-mit-git)
+   - [Grundlegende Git-Befehle](#grundlegende-git-befehle)
+3. [Best Practices für Datenanalyseprojekte](#best-practices-für-datenanalyseprojekte)
+4. [Zusätzliche Ressourcen](#zusätzliche-ressourcen)
+5. [Fazit](#fazit)
+
+---
+
+## Projektstruktur
+
+Eine gut organisierte Projektstruktur ist entscheidend für Zusammenarbeit und Skalierbarkeit. Hier ist ein empfohlenes Verzeichnislayout:
+
+```
+project-name/
+├── data/
+│   ├── model_weights/          # Trainierte Modellgewichte
+│   ├── raw/                    # Originale, unveränderte Datensätze
+│   └── processed/              # Bereinigte oder transformierte Daten
+├── code/
+│   └── my_python_program.py    # Python-Skripte
+├── figures/
+├── docs/
+│   ├── my_fancy_latex_thesis/  # LaTeX-Dateien für die Abschlussarbeit (empfohlen)
+│   ├── my_presentation.pptx    # Präsentationsfolien
+│   └── my_thesis.docx          # Word-Dokument (nicht empfohlen)
+├── .gitignore                  # Dateien und Verzeichnisse, die von Git ignoriert werden sollen
+├── README.md                   # Projektübersicht und Anleitungen
+└── requirements.txt            # Python-Abhängigkeiten
+```
+
+### Trennung von Daten und Code
+
+- **Datenverzeichnis (`data/`)**: Speichere hier alle deine Datensätze.
+  - `raw/`: Originale, unveränderte Datensätze.
+  - `processed/`: Daten, die bereinigt oder transformiert wurden.
+- **Quellcode-Verzeichnis (`code/`)**: Enthält alle Codeskripte und Module.
+
+**Vorteile:**
+
+- **Organisation**: Hält Daten getrennt vom Code, was die Verwaltung erleichtert.
+- **Reproduzierbarkeit**: Klare Trennung stellt sicher, dass Datenverarbeitungsschritte dokumentiert und wiederholbar sind.
+- **Zusammenarbeit**: Du und deine Kollaborateure können leicht verschiedene Komponenten des Projekts finden und verstehen.
+
+### Trennung von Abbildungen und Code
+
+- **Abbildungsverzeichnis (`figures/`)**: Speichere hier alle generierten Plots, Bilder und Visualisierungen.
+
+**Vorteile:**
+
+- **Klarheit**: Trennt Ausgaben vom Code und reduziert Unordnung.
+- **Versionskontrolle**: Einfachere Nachverfolgung von Änderungen im Code ohne große Binärdateien wie Bilder.
+- **Präsentation**: Vereinfacht das Erstellen von Berichten oder Präsentationen, indem alle Abbildungen an einem Ort gesammelt sind.
+
+---
+
+## Versionskontrolle mit Git
+
+Git ist ein leistungsstarkes Versionskontrollsystem, das dir hilft, Änderungen zu verfolgen, mit anderen zusammenzuarbeiten und die Historie deines Projekts zu verwalten. Aber was ist Versionskontrolle? Hast du jemals Dateien wie `project_final_v2.py` oder `project_final_final.py` erstellt? Versionskontrolle löst dieses Problem, indem sie Änderungen verfolgt und dir ermöglicht, zu früheren Versionen zurückzukehren. Als Bonus hast du auch ein Backup deines Projekts, falls etwas schiefgeht.
+
+### Grundlegende Git-Befehle
+
+- **Ein Repository initialisieren**
+
+  ```bash
+  git init
+  ```
+
+- **Remote-Repository hinzufügen (GitHub, Gittea)**
+
+  ```bash
+  git remote add origin <repository-url>
+  ```
+
+- **Ein Repository klonen**
+
+  ```bash
+  git clone <repository-url>
+  ```
+
+- **Status prüfen**
+
+  ```bash
+  git status
+  ```
+
+- **Änderungen hinzufügen**
+
+  ```bash
+  git add <dateiname>
+  # Oder alle Änderungen hinzufügen
+  git add .
+  ```
+
+- **Änderungen committen**
+
+  ```bash
+  git commit -m "Commit-Nachricht"
+  ```
+
+- **Zum Remote-Repository pushen**
+
+  ```bash
+  git push origin main
+  ```
+
+- **Vom Remote-Repository pullen**
+
+  ```bash
+  git pull origin main
+  ```
+
+#### Erweiterte Git-Befehle
+
+- **Einen neuen Branch erstellen**
+
+  ```bash
+  git branch <branch-name>
+  ```
+
+- **Zwischen Branches wechseln**
+
+  ```bash
+  git checkout <branch-name>
+  ```
+
+- **Branches zusammenführen**
+
+  ```bash
+  git merge <branch-name>
+  ```
+
+- **Commit-Historie anzeigen**
+
+  ```bash
+  git log
+  ```
+
+**Tipps:**
+
+- **Oft committen**: Regelmäßige Commits erleichtern das Nachverfolgen von Änderungen.
+- **Aussagekräftige Nachrichten**: Verwende beschreibende Commit-Nachrichten für besseres Verständnis.
+- **Verwende `.gitignore`**: Schließe Dateien und Verzeichnisse aus, die nicht verfolgt werden sollten (z. B. große Datendateien, virtuelle Umgebungen).
+
+---
+
+## Best Practices für Datenanalyseprojekte
+
+1. **Verwende virtuelle Umgebungen**
+
+   - Nutze `venv`, `conda` oder `pyenv`, um projektspezifische Abhängigkeiten zu verwalten.
+   - Dokumentiere Abhängigkeiten in `requirements.txt` oder verwende `poetry` für das Paketmanagement.
+
+2. **Dokumentiere deine Arbeit**
+
+   - Pflege eine klare und informative `README.md`.
+   - Verwende Docstrings und Kommentare in deinem Code.
+   - Führe ein Changelog für bedeutende Updates.
+
+3. **Schreibe modularen Code**
+
+   - Unterteile Code in Funktionen und Klassen.
+   - Nutze Code wieder, um Duplikate zu vermeiden.
+
+4. **Befolge Codierungsstandards**
+
+   - Halte dich an die PEP 8-Richtlinien für Python-Code.
+   - Verwende Linter wie `flake8` oder Formatter wie `black` oder `ruff`, um die Codequalität zu gewährleisten.
+
+5. **Automatisiere die Datenverarbeitung**
+
+   - Schreibe Skripte, um die Datenbereinigung und -vorverarbeitung zu automatisieren.
+   - Stelle sicher, dass Skripte von Anfang bis Ende ausgeführt werden können, um Ergebnisse zu reproduzieren.
+
+6. **Teste deinen Code**
+
+   - Implementiere Unit-Tests mit Frameworks wie `unittest` oder `pytest`.
+   - Halte Tests im Verzeichnis `tests/`.
+
+7. **Gehe sorgfältig mit Daten um**
+
+   - Committe keine Daten in die Versionskontrolle.
+
+8. **Versioniere Daten und Modelle**
+
+   - Speichere Modellversionen mit Zeitstempeln oder eindeutigen Kennungen.
+
+9. **Sichere regelmäßig**
+
+   - Pushe Änderungen häufig in ein Remote-Repository.
+   - Erwäge zusätzliche Backups für kritische Daten.
+
+10. **Arbeite effektiv zusammen**
+
+    - Verwende Branches für neue Funktionen oder Experimente.
+    - Führe Änderungen mit Pull Requests und Code Reviews zusammen.
+
+---
+
+## Zusätzliche Ressourcen
+
+- **Git-Dokumentation**: [git-scm.com/docs](https://git-scm.com/docs)
+- **PEP 8 Style Guide**: [python.org/dev/peps/pep-0008](https://www.python.org/dev/peps/pep-0008/)
+- **Python Virtual Environments**:
+  - [`venv` Modul](https://docs.python.org/3/library/venv.html)
+  - [Anaconda Distribution](https://www.anaconda.com/products/distribution)
+  - [`pyenv` Virtuelle Umgebungen](https://github.com/pyenv/pyenv)
+
+---
+
+## Fazit
+
+Die effektive Strukturierung deiner Datenanalyseprojekte ist der erste Schritt zu erfolgreicher und reproduzierbarer Forschung. Indem du Daten, Code und Abbildungen trennst, Versionskontrolle verwendest und bewährte Methoden befolgst, legst du ein starkes Fundament für deine Arbeit und die Zusammenarbeit mit anderen.
+
+Viel Spaß beim Programmieren!
--- a/code/README.md
+++ b/code/README.md
@ -1,5 +1,7 @@
 # Writing a Good Python Script: A Primer

+German version: [README_de.md](README_de.md)
+
 This primer will guide you through best practices to write effective and clean
 Python scripts. Whether you're working on a data processing pipeline, a machine
 learning model, or a simple utility script, following these guidelines will
--- a/code/README_de.md
+++ b/code/README_de.md
@ -0,0 +1,275 @@
+# Ein Leitfaden zum Schreiben eines guten Python-Skripts
+
+Dieser Leitfaden hilft dir dabei, effektive und saubere Python-Skripte zu schreiben. Egal, ob du an einer Datenverarbeitungspipeline, einem Machine-Learning-Modell oder einem einfachen Hilfsskript arbeitest – wenn du diese Richtlinien befolgst, erstellst du lesbaren code, der leicht zu warten und zu erweitern ist.
+
+## 1. Verwende einen aussagekräftigen und deklarativen Skriptnamen
+
+Wähle einen Skriptnamen, der klar beschreibt, was das Skript tut. So ist es für andere (und dich selbst) einfacher zu verstehen, was das Skript macht, ohne den Code lesen zu müssen.
+
+**Beispiele:**
+
+- `datenbereinigung.py` statt `skript1.py`
+- `bericht_generieren.py` statt `run.py`
+
+## 2. Beginne mit einer kurzen Erklärung (Docstring)
+
+Füge am Anfang deines Skripts einen Docstring ein, der kurz erklärt, was das Skript macht. Das hilft Nutzern, die Funktionalität des Skripts schnell zu erfassen.
+
+```python
+"""
+Dieses Skript lädt Rohdaten, bereinigt sie durch Entfernen von Nullwerten und Duplikaten und speichert die verarbeiteten Daten in einer neuen Datei.
+"""
+```
+
+## 3. Importiere alle benötigten Pakete am Anfang
+
+Liste alle deine Importe am Anfang des Skripts auf. Das macht Abhängigkeiten klar und vereinfacht die Wartung.
+
+```python
+import sys                # Pakete, die von Python bereitgestellt werden
+from pathlib import Path
+import numpy as np        # Pakete, die heruntergeladen und in requirements.txt angegeben sind
+import pandas as pd
+import mein_modul         # Module, die du selbst geschrieben hast
+```
+
+## 4. Organisiere Code in Funktionen und Klassen
+
+Organisiere deinen Code, indem du Funktionalitäten in Funktionen oder Klassen einbettest. Das fördert Code-Wiederverwendung, Testbarkeit und Lesbarkeit. Idealerweise sollten Funktionen eine Aufgabe erledigen und diese gut machen. Klassen können für komplexere Logik oder wenn du einen Zustand beibehalten musst, verwendet werden. Saubere Funktionen und Klassen enthalten _Type-Hints_ und _Docstrings_, um ihren Zweck sowie Eingaben/Ausgaben zu erklären.
+
+**Beispiele für Funktionen:**
+
+```python
+def lade_daten(dateipfad: str) -> pd.DataFrame:
+    """Lädt Daten aus einer CSV-Datei.
+
+    Parameters:
+    ----------
+    dateipfad : str
+        Pfad zur CSV-Datei.
+
+    Returns:
+    -------
+    pd.DataFrame
+        Geladene Daten als DataFrame.
+    """
+    return pd.read_csv(dateipfad)
+
+def bereinige_daten(df: pd.DataFrame) -> pd.DataFrame:
+    """Bereinigt den DataFrame durch Entfernen von Nullwerten und Duplikaten.
+
+    Parameters:
+    ----------
+    df : pd.DataFrame
+        Eingabe-DataFrame.
+              
+    Returns:
+    -------
+    pd.DataFrame
+        Bereinigter DataFrame.
+    """
+    df = df.dropna()
+    df = df.drop_duplicates()
+    return df
+
+def speichere_daten(df: pd.DataFrame, ausgabepfad: str) -> None:
+    """Speichert den DataFrame in einer CSV-Datei.
+
+    Parameters:
+    ----------
+    df : pd.DataFrame
+        Zu speichernder DataFrame.
+    ausgabepfad : str
+        Pfad zum Speichern der CSV-Datei.
+    """
+    df.to_csv(ausgabepfad, index=False)
+```
+
+**Beispiel für eine Klasse:**
+
+```python
+class DatenVerarbeiter:
+    """Eine Klasse zur Datenverarbeitung."""
+
+    def __init__(self, dateipfad):
+        self.daten = self.lade_daten(dateipfad)
+
+    def lade_daten(self, dateipfad):
+        return pd.read_csv(dateipfad)
+
+    def bereinige_daten(self):
+        self.daten.dropna(inplace=True)
+        self.daten.drop_duplicates(inplace=True)
+
+    def speichere_daten(self, ausgabepfad):
+        self.daten.to_csv(ausgabepfad, index=False)
+```
+
+## 5. Definiere eine `main()`-Funktion
+
+Erstelle eine `main()`-Funktion, die als Einstiegspunkt deines Skripts dient. Diese Funktion sollte den Ablauf deines Programms orchestrieren.
+
+```python
+def main():
+    """Hauptfunktion, die die Datenverarbeitung steuert."""
+    eingabedatei = 'data/raw/data.csv'
+    ausgabedatei = 'data/processed/bereinigte_daten.csv'
+
+    # Verwendung von Funktionen
+    daten = lade_daten(eingabedatei)
+    bereinigte_daten = bereinige_daten(daten)
+    speichere_daten(bereinigte_daten, ausgabedatei)
+
+    # Oder Verwendung einer Klasse
+    # verarbeiter = DatenVerarbeiter(eingabedatei)
+    # verarbeiter.bereinige_daten()
+    # verarbeiter.speichere_daten(ausgabedatei)
+
+    print("Datenverarbeitung abgeschlossen.")
+```
+
+## 6. Verwende die `if __name__ == "__main__":`-Anweisung
+
+Dies ist ein gängiges Python-Idiom, mit dem du prüfen kannst, ob das Skript als Hauptprogramm ausgeführt wird. So stellst du sicher, dass die `main()`-Funktion nur aufgerufen wird, wenn das Skript direkt ausgeführt wird. Wenn du die `main()`-Funktion direkt ausführst, wird sie nicht ausgeführt, wenn das Modul oder Teile davon in einem anderen Skript importiert werden.
+
+Füge also am Ende deines Skripts hinzu:
+
+```python
+if __name__ == "__main__":
+    main()
+```
+
+Dies prüft, ob das Skript als Hauptprogramm ausgeführt wird, und ruft entsprechend `main()` auf.
+
+## Alles zusammenführen
+
+So könnte dein Skript aussehen, wenn du all diese Best Practices kombinierst:
+
+```python
+"""
+Dieses Skript lädt Rohdaten, bereinigt sie durch Entfernen von Nullwerten und Duplikaten, und speichert die verarbeiteten Daten in einer neuen Datei.
+"""
+
+import os
+import sys
+import pandas as pd
+import numpy as np
+
+def lade_daten(dateipfad: str) -> pd.DataFrame:
+    """Lädt Daten aus einer CSV-Datei.
+
+    Parameter:
+    ----------
+    dateipfad : str
+        Pfad zur CSV-Datei.
+
+    Rückgabe:
+    -------
+    pd.DataFrame
+        Geladene Daten als DataFrame.
+    """
+    return pd.read_csv(dateipfad)
+
+def bereinige_daten(df: pd.DataFrame) -> pd.DataFrame:
+    """Bereinigt den DataFrame durch Entfernen von Nullwerten und Duplikaten.
+
+    Parameter:
+    ----------
+    df : pd.DataFrame
+        Eingabe-DataFrame.
+              
+    Rückgabe:
+    -------
+    pd.DataFrame
+        Bereinigter DataFrame.
+    """
+    df = df.dropna()
+    df = df.drop_duplicates()
+    return df
+
+def speichere_daten(df: pd.DataFrame, ausgabepfad: str) -> None:
+    """Speichert den DataFrame in einer CSV-Datei.
+
+    Parameter:
+    ----------
+    df : pd.DataFrame
+        Zu speichernder DataFrame.
+    ausgabepfad : str
+        Pfad zum Speichern der CSV-Datei.
+    """
+    df.to_csv(ausgabepfad, index=False)
+
+def main():
+    """Hauptfunktion, die die Datenverarbeitung steuert."""
+    eingabedatei = 'data/raw/data.csv'
+    ausgabedatei = 'data/processed/bereinigte_daten.csv'
+
+    daten = lade_daten(eingabedatei)
+    bereinigte_daten = bereinige_daten(daten)
+    speichere_daten(bereinigte_daten, ausgabedatei)
+
+    print("Datenverarbeitung abgeschlossen.")
+
+if __name__ == "__main__":
+    main()
+```
+
+## Zusätzliche Tipps
+
+- **Kommentiere deinen Code:** Verwende Kommentare, um nicht offensichtliche Teile deines Codes zu erklären. Strebe jedoch danach, Code zu schreiben, der selbsterklärend ist.
+- **Befolge die PEP 8-Richtlinien:** Halte dich an den [PEP 8](https://www.python.org/dev/peps/pep-0008/)-Styleguide für Python-Code, um die Lesbarkeit zu verbessern. Um dies zu erleichtern, verwende einen Auto-Formatter wie `black` oder `ruff`.
+- **Verwende aussagekräftige Variablen-, Funktions- und Klassennamen:** Wähle Namen, die ihren Zweck vermitteln. Vermeide Ein-Buchstaben-Variablennamen, außer für einfache Iteratoren. Statt `x` und `y` verwende z. B. `zeit` und `signal`.
+- **Behandle Ausnahmen:** Verwende try-except-Blöcke, um potenzielle Fehler elegant zu handhaben.
+
+  ```python
+  try:
+      daten = lade_daten(eingabedatei)
+  except FileNotFoundError:
+      print(f"Fehler: Die Datei {eingabedatei} wurde nicht gefunden.")
+      sys.exit(1)
+  ```
+
+- **Verwende Logging anstelle von Print-Anweisungen:** Für größere Skripte solltest du das `logging`-Modul verwenden, um eine bessere Kontrolle über Logging-Level und -Ausgaben zu haben.
+
+  ```python
+  import logging
+
+  logging.basicConfig(level=logging.INFO)
+
+  logging.info("Datenverarbeitung abgeschlossen.")
+  ```
+
+- **Parameterisiere deine Skripte:** Verwende Kommandozeilenargumente oder eine Konfigurationsdatei, um dein Skript flexibler zu gestalten.
+
+  ```python
+  import argparse
+
+  def parse_arguments():
+      parser = argparse.ArgumentParser(description="Daten verarbeiten und bereinigen.")
+      parser.add_argument('--input', required=True, help='Pfad zur Eingabedatei')
+      parser.add_argument('--output', required=True, help='Pfad zur Ausgabedatei')
+      return parser.parse_args()
+
+  def main():
+      args = parse_arguments()
+      daten = lade_daten(args.input)
+      bereinigte_daten = bereinige_daten(daten)
+      speichere_daten(bereinigte_daten, args.output)
+  ```
+
+- **Mache deinen Code modular:** Zerlege dein Skript in mehrere Dateien oder Module für bessere Organisation und Wiederverwendbarkeit. Verschiebe beispielsweise Datenverarbeitungsfunktionen, die in mehreren Skripten verwendet werden, in ein separates Modul namens `datenverarbeitung.py`.
+
+- **Coding einer Abbildung:** Wenn du eine Abbildung codest, kannst du unserem [Leitfaden zum Codieren einer Abbildung](https://github.com/bendalab/plottools/blob/master/docs/guide.md) folgen. Wenn du die gleichen Prinzipien auf deinen Abbildungscode anwendest, wird es einfacher, ihn zu modifizieren und wiederzuverwenden.
+
+## Fazit
+
+Wenn du diese Best Practices befolgst, erstellst du Python-Skripte, die:
+
+- **Lesbar** sind: Klare Struktur und Benennung machen deinen Code leicht verständlich.
+- **Wartbar** sind: Kapselung und Modularität vereinfachen Updates und Debugging.
+- **Wiederverwendbar** sind: Funktionen und Klassen können in anderen Skripten importiert und verwendet werden.
+- **Robust** sind: Fehlerbehandlung stellt sicher, dass dein Skript unerwartete Situationen handhaben kann.
+
+Denke daran, dass gute Codingraktiken nicht nur dir das Leben erleichtern, sondern auch anderen helfen, die vielleicht mit deinem Code arbeiten. Die Mühe, die du in das Schreiben sauberer und effektiver Skripte steckst, wird sich langfristig auszahlen.
+
+Viel Spaß beim Programmieren!
--- a/data/README.md
+++ b/data/README.md
@ -1,3 +1,28 @@
-# Tips and Tricks for the data directory
+# Structuring the `/data` Directory

-The filename should contain information about the date
+German version: [README_de.md](README_de.md)
+
+```
+project-name/
+├── data/
+    ├── raw/          # Original, unmodified data
+    ├── processed/    # Data derived from raw data
+    └── models/       # Model weights and outputs (if applicable)
+```
+
+## Guidelines
+
+- **`raw/`**:
+  - Store all original data exactly as collected.
+  - **Do not modify** these files to preserve data integrity.
+  - Include metadata or use clear filenames with dates to indicate when the data was recorded.
+
+- **`processed/`**:
+  - Place cleaned or transformed data here.
+  - Generate these files using scripts.
+  - Document processing steps if necessary.
+
+- **`models/`** (if you are training models):
+  - Save model weights, checkpoints, and outputs.
+  - Organize by experiment or model version if needed.
+  - Include metadata about training parameters or results.
--- a/data/README_de.md
+++ b/data/README_de.md
@ -0,0 +1,26 @@
+# Strukturierung des `/data`-Verzeichnisses
+
+```
+project-name/
+├── data/
+    ├── raw/          # Originale, unveränderte Daten
+    ├── processed/    # Aus Rohdaten abgeleitete Daten
+    └── models/       # Modellgewichte und Ausgaben (optional)
+```
+
+## Richtlinien
+
+- **`raw/`**:
+  - Speichere alle originalen Daten genau so, wie sie gesammelt wurden.
+  - **Verändere diese Dateien nicht**, um die Datenintegrität zu bewahren.
+  - Füge Metadaten hinzu oder verwende klare Dateinamen mit Datumsangaben, um anzugeben, wann die Daten aufgezeichnet wurden.
+
+- **`processed/`**:
+  - Lege hier bereinigte oder transformierte Daten ab.
+  - Erstelle diese Dateien mithilfe von Skripten.
+  - Dokumentiere bei Bedarf die Verarbeitungsschritte.
+
+- **`models/`** (falls du machine learning verwendest):
+  - Speichere Modellgewichte, Checkpoints und Ausgaben.
+  - Organisiere nach Experiment oder Modellversion, falls erforderlich.
+  - Füge Metadaten über Trainingsparameter oder Ergebnisse hinzu.