Add make build-docs target; align build_explorer.py with package ETL#33
Open
madsCodeBuddy wants to merge 2 commits intomainfrom
Open
Add make build-docs target; align build_explorer.py with package ETL#33madsCodeBuddy wants to merge 2 commits intomainfrom
madsCodeBuddy wants to merge 2 commits intomainfrom
Conversation
- Makefile: new 'build-docs' target that regenerates all three
docs/*.html artifacts from build_desert_farm.py,
build_desert_farm_summary.py, and build_explorer.py.
- docs/build_explorer.py: two latent bugs that surfaced when
attempting to actually run the script end-to-end:
(1) Default CSV path was 'data/local_data/time_space_reference_objects.csv'
but the canonical file moved to 'data/datasets/' during the
data reorg. Updated default to point at canonical location.
(2) Ellipse coord assignment was missing the
.rename(columns={0: 'x_coords', 1: 'y_coords'}) step that
etl.transform_process_response_sheet uses; without it,
pandas alignment fails and ellipse rows get NaN coords,
causing AttributeError downstream. Added the rename to
mirror the etl.py pattern.
- docs/*.html: regenerated via 'make build-docs' to verify the
target works end-to-end.
Note: regenerated explorer.html is 688KB vs the prior 880KB
committed file (213 -> 159 coord lists). The script now runs
cleanly but visual verification is recommended; the size
difference may indicate the prior file was generated under
different conditions (older CSV, different package version, etc).
Replaces the hand-rolled load_reference_objects with a thin adapter around timeSpace.etl.transform_process_response_sheet, mirroring the pattern PR #30 established for build_desert_farm.py. Why: the script's hand-rolled ETL had drifted from the package version. The previous commit on this branch fixed one symptom (missing .rename(columns={0: 'x_coords', 1: 'y_coords'}) after result_type= 'expand'), but the underlying issue was duplicated-and-stale code. Other things load_reference_objects was missing vs the package ETL: - Filtering rows where Time_min > Time_max or Space_min > Space_max - FillAlpha / TextAlpha (script uses fixed 0.0 for hidden state, so these are unused but harmless additions) - Time Max / Space Min derived columns (also unused, harmless) Adapter pattern (same as build_desert_farm.py's load_processes): - Rename Name -> FullName so create_name's ShortName fallback inside the ETL doesn't overwrite the descriptive name used for hover/labels - Map Category -> Color (uppercase to match POSSIBLE_COL_LIST) - Set ShortName = FullName (reference objects don't have separate short forms, but create_name needs the column to exist) Behavior verification: regenerated explorer.html is byte-for-byte identical to the previous commit (688,092 B, 159 coord lists with content >= 100 chars), so this is a pure code-quality change with no rendered output difference. Drops numpy import (was only used in the manual label_x / label_y computation that the package ETL now handles).
madsCodeBuddy
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
make build-docstarget. Bringsdocs/build_explorer.pyfully up-to-date with the current package — its hand-rolled data loading had drifted, and the script wasn't actually runnable end-to-end against the current repo layout.Commits
1.
Add make build-docs target; fix build_explorer.py end-to-endbuild-docstarget runningbuild_desert_farm.py,build_desert_farm_summary.py,build_explorer.py.docs/build_explorer.py— two latent bugs surfaced trying to run end-to-end:data/local_data/time_space_reference_objects.csvfrom before the data reorg. Now points atdata/datasets/..rename(columns={0: "x_coords", 1: "y_coords"})afterresult_type="expand"— without it, pandas alignment-by-name was producing NaN coords and_patch_coordswas crashing withAttributeError: 'float' object has no attribute 'tolist'. Patched inline as a minimal fix.docs/*.html: regenerated to verify the target works.2.
Align build_explorer.py with package ETL pipelineReplaces the hand-rolled
load_reference_objectswith a thin adapter aroundtransform_process_response_sheet, mirroring PR #30's pattern forbuild_desert_farm.py. The minimal.renamefix in commit 1 was a band-aid; this is the proper fix — the underlying issue was duplicated-and-stale code.Adapter pattern (matches
load_processesinbuild_desert_farm.py):Name → FullNamesocreate_name'sShortNamefallback inside the ETL doesn't overwrite the descriptive name used for hover and labels.Category → Color(uppercase to matchPOSSIBLE_COL_LIST).ShortName = FullName(reference objects don't have separate short forms, butcreate_nameneeds the column to exist).Things the script was missing vs the package ETL:
Time_min > Time_maxorSpace_min > Space_max(current CSV has no such rows, but the safety net is there now)FillAlpha/TextAlphacolumns (script uses fixed0.0for hidden state, so these are unused but harmless)label_x/label_ycomputation, which the package ETL now handles)Behavior verification:
explorer.htmlis byte-for-byte identical to the output from commit 1 — 688,092 B, 159 content-bearing coord lists. Pure code-quality change.Note on the size delta vs prior committed
explorer.htmlThe regenerated
explorer.htmlis 688 KB (159 coord lists) vs the previously-committed 880 KB (213 coord lists). Investigated this in the second commit — the size drop is not caused by the refactor (refactored output is identical to the v1 single-fix output). Most likely the prior committed file was generated under different conditions (oldern_points, oldercreate_ellipse_data, or older CSV). Squashed history makes this unrecoverable. Worth a visual check before merge.Branch hygiene
compare/main...feat/build-docs-target:status=ahead, ahead_by=2, behind_by=0✓