pypsa-meets-earth/pypsa-earth

Revise section model customization in readthedocs

Open

#1,342 opened on Feb 5, 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

revise the "model customization"

  • 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

Contributor guide

Research direction
Review the current 'model customization' section in the readthedocs tutorial. Understand the config.yaml management for incremental changes and update the tutorial to reflect the revised structure, including sections for customizing network data and renewable production.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75