PyPSA / PyPSA/pypsa-usa

Documentation for godeep dataset

Open
#694 0 comments 0 reactions 1 assignee View on GitHub

@asiazzzhang is already working on this.

Since Sep 30, 2025.

documentation
Dominant language
Python
Stars
148
Forks
55
Avg merge
2d 11h
Merged PRs (30d)
18

Description

Type of documentation issue

Missing Information

Issue Description

PR #680 and #682 added godeep for renewable data!🎉 I think the documentation needs to get updates to match the config file. Specifically, these are the config options, followed by my questions:

renewable:
  dataset: godeeep # [atlite, godeeep]

## implement wildcard for this, following interconnect example
renewable_weather_years: [2019]
snapshots:
  start: "2019-01-01"
  end: "2019-12-31"
  inclusive: "left"

## godeeep inputs for scenarios
renewable_scenario_years: [2033]
renewable_scenarios: ["rcp45hotter"] #["historical", "rcp45hotter", "rcp45cooler", "rcp85hotter", "rcp85cooler"]
renewable_snapshots:
  start: "2033-01-01" ## change the year to match renewable_scenario_years
  end: "2033-12-31"
  inclusive: "left"
  1. The renewable dataset is self explanatory, but would be good if the config tables linked to the raw sources/repositories?

  2. What is the difference between the snapshots and the years options? Feels like we should just be able to specify one for each (ie. renewable_weather_years or snapshots instead of both? Same for renewable_scenario_years and renewable_snapshots)

  3. What is the first year we can use for the renewable_scenario_years? With historical I guess we can use whatever year we want? Would be good to specify in the config tables.

  4. Does it make sense to collapse the renewable_weather_years and renewable_scenario_years into one value? Then just use the renewable.dataset value to check what data to pull? I know if using atlite you would just need to check that its a year, and not a rcp scenario, tho. (I havent actually tried to godeep dataset, so this may not make sense! Just a thought)

  5. In the config table for the godeep renewable scenarios, is there a doc we can link to that describes the differences between each choice?

Link to existing documentation

No response

Suggested Update

No response

Additional Info

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.