pypsa-meets-earth/pypsa-earth

Improve documentation of power model

Open

#1,309 opened on Jan 20, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (349 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (351 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the feature you'd like to see

Beyond improving the documentation of the sector model #1208, the power model may benefit from improvements:

  • #1340
  • #1341
    • To revise the configuration.rst file to ensure the proper configuration parameters are mapped accordingly. For example, in top configuration, custom_rules is missing
    • Check if all power configurations are available in the configtables
  • #1342
    • probably general modelling guidelines is not needed
    • revise basic customization to reflect the renewed config.yaml management of incremental changes and explain to the user that it shall copy from config.default and place in config. yaml
    • Include a section to customize network data information
    • include a section to customize renewable production, though we shall provide better interfaces for this
  • description of alternative clustering
  • augmented network connections

Please, comment if you identify more to add

Contributor guide

Research direction
Review the configuration.rst file and configtables directory to identify missing configuration parameters and ensure mappings. Then revise the documentation sections as listed.
Tech stack
python
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitPythonreStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65