From e7c93eec750e11b29274a742575cf476b016cf86 Mon Sep 17 00:00:00 2001 From: aaron Date: Tue, 25 Aug 2026 11:36:00 +0200 Subject: [PATCH] doc(README): add a minimal readme file --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7c7606..53b11e0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # helioviewer_grab -Fetches an image from the helioviewer api at a given time \ No newline at end of file +Kleines Skript, das ein Sonnen-Vollscheibenbild von [Helioviewer](https://helioviewer.org) +zu einem gewünschten Zeitpunkt herunterlädt. + +Es sucht in der Helioviewer-API die Datenquelle passend zum angegebenen +Stichwort (z.B. `hmi_continuum`), holt das dem Zeitpunkt am nächsten liegende +Bild und speichert es als PNG im aktuellen Verzeichnis. + +## Nutzung + +```bash +./helioviewer_grab.py 2026-08-12T18:18:00Z hmi_continuum +./helioviewer_grab.py --list # verfügbare Datenquellen anzeigen +``` + +Ohne Argumente werden Beispielwerte verwendet (siehe Docstring im Skript). + +## Requirements + +Nur die Python-Standardbibliothek, keine Dependencies. +Mit [devenv](https://devenv.sh) steht der passende Interpreter direkt bereit: + +```bash +devenv shell +``` + +## Author + +Aaron Schmocker