Recalculate & Show Building Ward Data + Ward Pages by wangbertha · Pull Request #178 · vkoves/electrify-chicago

wangbertha · 2025-04-02T19:32:27Z

Description

This pull request calculates and adds Ward number to the data that is used for the individual buildings pages (Issue #56).

Requesting review on standalone functions and call point in the data pipeline before next steps (next steps are in the subsequent comment).

Fixes #56

Testing Instructions

The function to add Ward number may be tested by running add_ward_numbers.py.

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

wangbertha · 2025-04-02T19:32:53Z

Next Steps:

Run through data pipeline to update building information.
Display Ward number data in the frontend.
Add filters by Ward.
Consider adding resource links for users to contact their alderpeople.

netlify · 2025-04-02T19:33:08Z

✅ Deploy Preview for radiant-cucurucho-d09bae ready!

Name	Link
🔨 Latest commit	`2d72532`
🔍 Latest deploy log	https://app.netlify.com/projects/radiant-cucurucho-d09bae/deploys/68435fbe1065e00008cdc282
😎 Deploy Preview	https://deploy-preview-178--radiant-cucurucho-d09bae.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

vkoves

@wangbertha - this looks good, and I support keeping this a separate PR that just adds the corrected wards! I have a few notes, but the other big one is let's add some tests! I'd think it could be super simple, like confirming three known buildings get mapped to the right wards.

Based on improved pyproject.toml format

Returns -1 if there is no Ward number

wangbertha · 2025-04-16T16:46:35Z

In-Progress: Adding tests, and resolving data discrepancies!

wangbertha · 2025-05-27T22:42:26Z

@vkoves I integrated the 3 methods to find Ward numbers into the data pipeline. I think we should use the City Geocoding method, so I added tests that run against that method.

+
+// TODO: Figure out a way to get metaInfo working without any
+// https://github.com/xerebede/gridsome-starter-typescript/issues/37
+@Component<any>({


vkoves

@wangbertha - great work! I poked a few buildings and the ward numbers seemed sound, so I helped you out on the front-end and added the ward number to each building, and made a quick "Ward" template, so that you can see buildings for each ward 🎉

This was a highly requested featured by our advocates and should help us target specific alderman!

Building Page	Ward Page

My asks:

Now that you've tried the three different approaches, can we trim down the final output to one, and maybe call it WardCalculated or something? (to make clear it's not what comes from the raw data)
I appreciate you adding README's to your files, but should you add anything to the overall README to make sure folks re-run your code when there's a new data update?

Alternatively, we could also just call it Ward, since the city field is called Wards, and the final data is ultimately for us 🤷🏻‍♂️

wangbertha · 2025-06-04T05:35:06Z

@vkoves Thank you for the review! I have made your requested updates. I called the final column Ward (fyi- it looks like the most recent benchmarking dataset this year doesn't even include the Wards column!). In the frontend, I updated any instances of WardByCityGeocoder to Ward to match this.

I also updated the individual building page to display Not found if the City Geocoder did not return a value.

Let me know if any other changes would be necessary or helpful!

vkoves · 2025-06-06T17:27:32Z

-    elif building['WardByGMapsCoordinates'] == building['WardByGMapsCoordinates']:
-        return -4
-    return -5
+# def find_ward_number_by_obj_coordinates(ward_shapes: pd.DataFrame, coordinatesStr: str) -> int | None:


@wangbertha - should this code just be deleted? We shouldn't merge in large blocks of commented code

Yes, I can delete these! Do you think I should also remove the source files for the methods we are not using? Those would be BuildingCoordinates.csv and WardShapes.csv.

I think the shapes might be useful (for future rendering) but I trust your judgement on that. It's fine if we have unused code if we have a plan to use it in the future, but you can always come back to this PR and retrieve code if you need it again!

Makes sense! I'll remove them for now, so that if they are used later, they will be associated with the PR that uses them for rendering. Plus, it doesn't take long to add them!

vkoves · 2025-06-06T22:29:13Z


-2. To then process a new CSV file (at `src/data/source/ChicagoEnergyBenchmarking.csv`), you need to run the following command:
+2. If you update the [Chicago Energy Benchmarking Data](https://data.cityofchicago.org/Environment-Sustainable-Development/Chicago-Energy-Benchmarking/xq83-jr8c/about_data)
+   (`src/data/source/ChicagoEnergyBenchmarking.csv`), you need to update `src/data/source/CityGeocoder.xlsx` by following the


I missed this earlier, so we can handle it next time, but why did this end up being an XLSX file? I swear it was a CSV before, because I checked it 🤔

I think for the follow up it would also be helpful to explain what that file is. I also notice in the geocode process that it takes the whole file and a manual process, but since buildings don't shift over time, we probably want to make a process that only geocodes new addresses. That can be a future improvement though!

vkoves

Had one last comment, but not going to block this, especially with EcoFest tomorrow! I don't think I fully understood how the geocode process works, but now that I do I have some thoughts for future improvement

wangbertha · 2025-06-06T22:50:53Z

The typo you caught earlier was actually a typo for another ward method! The City Geocoder takes in and outputs an Excel file. There might be a way to pull the data through an API call (perhaps as used in the WardWise project), where we might be able to reduce manual steps even more.

Agreed that we can optimize the script further to just query new buildings!

wangbertha added 5 commits April 2, 2025 13:01

Add WardsShapes data

b1a2f3e

Create functions to calculate ward data

644d6bd

Add Ward number retrieval to data pipeline

8833b12

Update data sources in README

b560af9

Fix function name when called in process_data.py

e9b9b61

wangbertha requested a review from vkoves April 2, 2025 19:33

vkoves requested changes Apr 4, 2025

View reviewed changes

wangbertha added 4 commits April 8, 2025 12:48

Update Python dependency files

bb4c6db

Based on improved pyproject.toml format

Clean up documentation (comments, data types, etc)

66592aa

Convert Ward number in Data Frame type to int

e1929dd

Returns -1 if there is no Ward number

Rerun data pipeline with Ward numbers added

e0e0b19

vkoves self-assigned this Apr 25, 2025

wangbertha added 11 commits May 19, 2025 19:00

Calculate geocode from addresses and save to CSV

279a710

Organize GMaps Coordinates script and update docs

7247527

Create instructions to pull City Geocode info

28f97e4

Add City Geocode information

559fde4

Change building coordinates source file name

e0c7b4e

Add ward numbers via. 3 methods to bdg. benchmarks

8aeecf4

Rerun data pipeline with all 3 Ward-finder methods

d5b23ca

Add tests for WardsByCityGeocoder building attr.

960a206

Remove Ward Boundary mention from README

e12e16a

Merge branch 'main' into find-building-ward-data

b54ba35

Run Prettier with --write

ac2456d

wangbertha requested a review from vkoves May 27, 2025 22:42

Show ward numbers and create ward pages

454329d

github-advanced-security AI found potential problems Jun 1, 2025

View reviewed changes

Fix CSS

9102dea

vkoves requested changes Jun 1, 2025

View reviewed changes

Comment thread eslint.config.mjs

Comment thread src/data/scripts/building-coordinates/README.md Outdated

vkoves changed the title ~~Find building ward data~~ Recalculate & Show Building Ward Data + Ward Pages Jun 1, 2025

wangbertha added 10 commits June 3, 2025 21:08

Fix typo in Building Coordinates README

06eba4a

Re-run data pipeline to only save 1 Ward method

6146f72

Add CityGeocoder instructions to overall README

3006400

Remove Coordinates and re-run data pipeline

1a89219

Run prettier

1b56605

Update WardByCityGeocoder to Ward in page + test

b788a55

Run prettier

695fe96

Display text when building does not have Ward

b1ed138

Update WardByCityGeocoder to Ward in Ward page

cd2c48d

Fix display when building does not have Ward

e3e115e

wangbertha requested a review from vkoves June 4, 2025 05:35

vkoves reviewed Jun 6, 2025

View reviewed changes

wangbertha added 2 commits June 6, 2025 16:36

Remove unused code

a9d6f00

Remove unused source files

2d72532

wangbertha requested a review from vkoves June 6, 2025 21:41

vkoves reviewed Jun 6, 2025

View reviewed changes

vkoves approved these changes Jun 6, 2025

View reviewed changes

vkoves merged commit 4906273 into main Jun 6, 2025
7 checks passed

vkoves deleted the find-building-ward-data branch June 6, 2025 22:29

Conversation

wangbertha commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing Instructions

Checklist:

Uh oh!

wangbertha commented Apr 2, 2025

Next Steps:

Uh oh!

netlify Bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for radiant-cucurucho-d09bae ready!

Uh oh!

vkoves left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wangbertha commented Apr 16, 2025

Uh oh!

wangbertha commented May 27, 2025

Uh oh!

Check warning

vkoves left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

wangbertha commented Jun 4, 2025

Uh oh!

vkoves Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

wangbertha Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

vkoves Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

wangbertha Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

vkoves Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

vkoves left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wangbertha commented Jun 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

wangbertha commented Apr 2, 2025 •

edited

Loading

netlify Bot commented Apr 2, 2025 •

edited

Loading