Skip to content

DATA_UPDATE_CHECKLIST.md

Latest commit

 

History

History
46 lines (30 loc) · 1.64 KB

DATA_UPDATE_CHECKLIST.md

File metadata and controls

46 lines (30 loc) · 1.64 KB
Raw

Data Update Checklist

If you are updating the site to use a new year's benchmarking data copy the list below to your PR template, to indicate you've completed all steps!

Required Steps

  • Download new data to repo - download the latest data from the Chicago Energy Benchmarking Data Portal and update src/data/source/ChicagoEnergyBenchmarking.csv with the new file

  • Run data processing:

    docker-compose run --rm electrify-chicago uv run python run_all.py

  • Fetch updated ward numbers for new buildings - Follow instructions in src/data/scripts/city-geocodes/README.md to generate updated src/data/source/CityGeocoder.xlsx file using the City of Chicago Geocoder

  • Regenerate Python test data:

    docker-compose run --rm electrify-chicago bash create_test_data.sh

  • Update FE latest year constant in src/constants/globals.vue (change LatestDataYear)

  • Run tests and fix failures:

    docker-compose run --rm electrify-chicago python -m pytest

  • Regenerate social images:

    yarn gen-fresh-social-imgs

  • Update Release Notes - Add data update section to src/pages/ReleaseNotes.vue

Common Test Fixes Needed

  • Column mismatches: Update expected column lists if data structure changed
  • Count mismatches: Adjust expected record counts in test files
  • Year expectations: Update hardcoded years in test assertions
  • Ward changes: Update expected ward assignments if buildings moved