Document the pipeline runner (presets, config blocks, time-step selection)

Aperta
  • Qualcosa non va?
#772 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Start with doc/userguide/ and the referenced entry points: edisgo.run, edisgo/run/presets/*.yaml, and edisgo/run/tasks/timeseries.py. Read the runner config and task docstrings, then compare them with each preset and its comments. Add the proposed guide with the config, pipeline, preset, and time-step details, link to it from the preset headers and task docstrings, and confirm every requested topic and preset has an example.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: runner documentation

Problem

The pipeline runner (edisgo.run, run_edisgo) has no page in the documentation. A user who runs eDisGo through it has to piece the concepts together from module docstrings and preset comments:

  • edisgo/run/__init__.py describes the pipeline and extends, but not the top-level config blocks that tasks read (timestep_selection, spatial_reduction, overlying_grid, flexibilities, database, results).
  • The bundled presets (edisgo/run/presets/*.yaml) are only documented by their own comments; there is no overview of what each one runs and when to use it.
  • The time-step selection (timestep_selection block with task: set_timeindex | select_critical_timesteps | none, or inline step params without the block) is explained only in the module docstring of edisgo/run/tasks/timeseries.py.
  • flex_opf restricts the loaded window through oedb_ts: {timeindex: ...}, a third way of limiting the time steps that is not related to the selection block. This should be explained next to it.

Proposal

Add a user guide page, e.g. doc/userguide/runner.rst, covering:

  1. Running a config (run_edisgo with a dict or a YAML/JSON file, overlying_grid_data).
  2. Pipeline steps, inline params, and the validator (what it checks before the run).
  3. Presets and extends (deep merge: dicts merged key-wise, lists such as pipeline replaced, null overrides).
  4. The top-level blocks, with a table for timestep_selection (which task runs per task value, that the other step stays in the pipeline and is skipped, when to use the block vs. inline params, timestep_selection: null).
  5. A short example per preset.

Then point the preset header comments and the task docstrings to that page.

Lingua principale
Python
Stelle
48
Fork
22
Merge medio
1g 8h
PR unite (30g)
37

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openego/eDisGo

Tutte le issue di openego/eDisGo

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.