Support pinned historic OSM snapshots for reproducibility

オープン
  • 何か問題がありますか？
#10 コメント 2 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
30/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python, yaml
領域
data-engineering

調査の方向性

Start by reading workflow/scripts/_schema.py and the existing retrieve.target_date handling, then compare the proposed osm_data config with the referenced PyPSA-Earth PR #2005 and the historical test config in pypsa-earth-osm. First resolve the open questions about the historical-data backend, date granularity and output metadata. Done means historical snapshots are validated and stored separately, the historical path runs in CI, and the docs explain reproducibility and its limits.

索引モデルが issue の本文から書いたものです。

説明

Is your feature request related to a problem? Please describe.

Grid models built from "latest" OSM data cannot be reproduced. OSM changes continuously, so the same config run a month apart yields a different network. Results, validation and published studies cannot be re-run or compared against a fixed input. Pinning the OSM snapshot date is a prerequisite for reproducible runs.

Describe the solution you'd like

A config-selectable OSM data source with an explicit snapshot date, and snapshots stored per date so runs with different dates never overwrite each other.

Proposed config (same shape as the one already implemented in PyPSA-Earth):

osm_data:
  source: historical      # latest | historical | custom
  target_date: "2020-01-01"   # YYYY-MM-DD, required for historical
  • latest: current OSM data (default, unchanged behaviour)
  • historical: data as of target_date
  • custom: user-provided .pbf and optional pre-filtered power files

Raw data is stored per snapshot, e.g. data/osm/<subdir>/ where <subdir> is YYYYMM, latest or custom.

Acceptance criteria:

  • Same config + same target_date gives identical raw OSM input across runs
  • Different dates are stored in separate directories and do not overwrite each other
  • target_date is validated (format, not in the future, not before the earliest supported snapshot)
  • A test config exercising the historical path (e.g. target_date: 2020-01-01) runs in CI
  • Docs describe the options and the reproducibility guarantee and its limits

Prior work (what is already done and can be reused)

  • pypsa-earth-osm
    • #5 historical OSM data integration (from earth-osm#63)
    • #16 separate OSM data into date-specific directories
    • #27 test config for historical data (test/config.historical.yaml)
  • pypsa-earth
    • #2005 ports the feature with the osm_data config section above; requires earth-osm>=3.0.2 (open)

Describe alternatives you've considered

  • Pinning a downloaded .pbf by hand (custom source): works, but the snapshot date is not recorded in the config and is easy to lose.
  • Committing/archiving the raw data per study: heavy, and does not scale across users.

Open questions

  • Which backend should serve historic data here (earth-osm historical feature vs Geofabrik history files vs Overpass date: queries)? Each has a different earliest date and coverage.
  • Should the resolved snapshot date be written into the output metadata so results are traceable?
  • Granularity of the snapshot: month (YYYYMM, as in PyPSA-Earth) or exact date?

Additional context

Related: retrieve.target_date in grid-builder (workflow/scripts/_schema.py) currently exists but is only honoured for retrieve.source: geofabrik, so the Overpass path is not reproducible today.

主要言語
Python
スター
7
フォーク
2
30日以内にマージされた PR はありません

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

PyPSA/grid-builder のほかの issue

PyPSA/grid-builder の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。