PyPSA/pypsa-usa

Clarify costs rule names/scopes

Open

#231 opened on Mar 20, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (52 forks)auto 404
enhancementgood first issue

Repository metrics

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

Description

Feature Request

We have the following rules:

  • build_cost_data
  • build_fuel_prices
  • retrieve_cost_data_usa
  • retrieve_cost_data_eur
  • retrieve_eia_data

From a naming perspective, it is not entirely clear what the differences are. For example, some fuel costs come from build_cost_data if using the ATB, while others are created in build_fuel_costs if they are dynamic. Clarity on scope and name would be good!

Suggested Solution

No response

Additional Info

No response

Contributor guide

Research direction
Look at each rule's code and documentation to identify their specific scopes and inputs/outputs, then propose clearer naming conventions.
Tech stack
python
Domain
backenddata
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85