pypsa-meets-earth/pypsa-earth

Document usage of data retrieval CLI

Open

#1,742 opened on Mar 4, 2026

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

Repository metrics

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

Description

Describe the feature you'd like to see

We have command line interface for data retrieval introduced in #1366 but it's usage is not obvious at all when starting to use the model. We need to find a way to make it more evident since data retrieval is one of the trickiest parts of the modelling workflow. A possible solution would be to include a reference to the CLI if data retrieval fails

@willu47 Thanks a lot for the feedback!

Contributor guide

Research direction
Examine the CLI implementation in PR #1366 and the data retrieval failure code path to add a hint about the CLI usage.
Tech stack
python
Domain
backendclidata
Issue type
Feature
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75