pypsa-meets-earth/pypsa-earth

Add sector-coupled configuration to docs

Open

#1,208 opened on Nov 27, 2024

View on GitHub
 (0 comments) (3 reactions) (0 assignees)Python (349 forks)auto 404
documentationgood first issuehelp wantedsector-coupling

Repository metrics

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

Description

Describe the feature you'd like to see

We have a nice documentation of the electricity-only PyPSA-Earth. However, this is also necessary for the sector-coupled part. Potentially rely on https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4743242 for information.

This can be done here: https://github.com/pypsa-meets-earth/pypsa-earth/blob/main/doc/configuration.rst

Contributor guide

Research direction
Review the existing electricity only configuration documentation at https://pypsa earth.readthedocs.io/en/latest/configuration.html and the paper at https://papers.ssrn.com/sol3/papers.cfm?abstract id=4743242 to understand sector coupled parameters. Then add equivalent documentation to doc/configuration.rst.
Tech stack
python
Domain
backend
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