deped-geos
deped-geos is a producer: a Polars-first build that turns school records
and PSGC geography into school-derived area artifacts. It is layered on the
shared deped-primitives library (reusable hierarchy, territory, boundary,
PSGC, urbanicity, and legislative semantics) and keeps only what is bound to its
own artifact contract. Canonical boundary artifacts remain exact; the producer
also publishes a versioned current-year display tier for high-complexity
derived division and legislative-district maps.
It emits three artifact hierarchies plus national and region-group reporting rows:
- Normalized PSGC stats by region, province, city, municipality, locality, and barangay.
- DepEd governance stats starting at region, with compatibility boundary GeoParquet for division and school district.
- Legislative stats starting at region, with compatibility boundary GeoParquet for legislative district.
(Strict psgc is an internal denominator/ordering construct only; it is never
emitted as an artifact hierarchy.)
The producer consumes two sibling build outputs:
../deped-dataset/artifacts/db.sqlite3 for source-school tables and
../deped-maps/artifacts-current for PSGC CSV, area-boundary component, and
GeoParquet artifacts. It writes Parquet tables, partitioned membership data,
compatibility GeoParquet boundaries, and a manifest with source fingerprints,
source-contract status, timings, and geometry policy. Boundary GeoParquet is
written with PyArrow and Shapely; the geometry column is WKB bytes for
consumers to decode at their own display/API boundary.
In plain terms: run just build after deped-dataset and deped-maps are
fresh. The build reads those sibling outputs once and creates this repo's local
artifacts-current/ folder. The notebook workbench then reads that folder
read-only; it does not go back to the dataset DB or rerun the build. The only
extra lookup is PSGC map geometry, which the notebook uses from bundled or
recorded deped-maps artifacts when a PSGC map needs to be drawn.
The installed distribution is deped-geos; the Python package is
deped_geos. Runtime code is grouped by ownership: deped_geos.artifacts,
deped_geos.sources, deped_geos.products, deped_geos.producer, and the
read-only deped_geos.workbench helpers. See docs/architecture.md for the
full role, ownership boundaries, and engine policy.
Quick start
uv sync --all-groups
cd ../deped-dataset && just build
cd ../deped-maps && just build
cd ../deped-geos
just check
just build --output-dir artifacts-current
uv run deped-geos status --output-dir artifacts-current
just build remains the single deped-geos build command. It validates sibling
inputs but does not rebuild them. If the dataset DB or PSGC bundle is stale or
incomplete, the build fails with instructions to refresh upstream:
cd ../deped-dataset && just build
cd ../deped-maps && just build
Compatibility boundary GeoParquet files are a required producer output when
source geometry is present. The producer writes them with PyArrow and Shapely in
the normal uv run deped-geos build / just build path. The default test
environment installs the dev and workbench dependency groups so just check
runs the full collected test suite.
Outputs
artifacts-current/ contains:
manifest.jsonschool_spine.parquetschool_spine_current.parquetschool_area_source_universe.parquetschool_area_stats.parquetschool_area_assignment_audit.parquetschool_area_memberships/school_area_region_group_components.parquetschool_area_division_coverage.parquetschool_area_division_coverage_audit.parquetschool_area_denominator_coverage.parquetschool_area_insight_context.parquetschool_area_display_subdivisions.parquetschool_id_crosswalk.parquetschool_area_boundaries_governance_division.parquetschool_area_boundaries_governance_school_district.parquetschool_area_boundaries_legislative_legis_district.parquetschool_area_governance_context.parquetschool_area_boundaries_*_current.parquetschool_area_boundaries_governance_division_display_current.parquetschool_area_boundaries_legislative_legis_district_display_current.parquet
Area-grain stats, assignment audit, denominator and division coverage, insight
context, display subdivisions, and derived boundaries are keyed by
school_type_scope and school_year_id. The manifest marks the latest year as
current and lists school-type scopes beginning with __all_active__
(All active schools) and Public • DepEd. School spine and memberships stay
single-copy school-grain artifacts with the existing school_type column.
Coordinate correctness review belongs exclusively to the deped-maps review
workbench; geos keeps latitude and longitude but does not mirror coordinate QA.
CSV exports are optional: run just build --export-csv when a downstream handoff needs CSV copies.
school_area_stats.parquet owns the complete group universe for every
(school_type_scope, school_year_id, hierarchy, level, group_id): current-year
group counts, denominators, labels, and parent ids belong there. Boundary
GeoParquet files own renderable geometry only. Governance and legislative
geometry comes from deped-maps area_boundary_components.csv source
components, repeated only for matching scoped stats rows. Derived boundary
GeoParquet is an exact dissolve. Contract 30 additionally publishes current-only
display geometry for divisions and legislative districts. It is simplified as
one coverage per parent region under derived_boundary_display_v1, with
component, ring, bounds, and area guards; a failing partition keeps exact WKB.
The manifest records the display path, fingerprint, QA receipt, and policy while
the canonical path and current_path remain exact. A current stats row without a
matching school_area_boundaries_*_current.parquet row is valid and means the
group is known, but has no display geometry for consumers to draw. Downstream
apps should select display_current_path for current maps, treat geometry as
WKB, and perform GeoJSON serialization outside the producer.
school_area_governance_context.parquet is a separate ADM4 collection of
canonical barangays classified upstream as no_observed_district. It is map
context only: consumers render it neutrally behind observed governance areas
and exclude it from metric joins, aggregation, tables, charts, and numeric
legend bins.
school_area_stats.parquet also includes shared planning ratios such as
students_per_school, students_per_capita, population_per_school,
school_density, area_per_school, plus urban_barangay_share and
barangay_urbanicity_band. These are producer-emitted artifact fields backed
by deped-primitives metric and urbanicity semantics; notebooks and downstream
consumers should read them rather than recomputing them at runtime.
school_area_source_universe.parquet preserves PSGC labels, parent ancestry,
boundary mapping, and denominator seeds for no-school groups so boundary-first
maps can render known geography without downstream inference.
Docs and notebooks
uv run zensical build
just notebooks
just check-full
The local Marimo notebooks inspect artifacts-current/ read-only and render
maps in-cell. They do not expose a server/API contract.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file deped_geos-0.7.1.tar.gz.
File metadata
- Download URL: deped_geos-0.7.1.tar.gz
- Upload date:
- Size: 292.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3a70c07e9d7d0445fb10d83b6a7ce225c4b48191dd58b855efa5d02d2d094ebe
|
|
| MD5 |
2a2c4f58ace6c30ee2336d400c175e8e
|
|
| BLAKE2b-256 |
cc3aa1d8876d4343ec3e7339fbd1bc728a9c356e6b67939e157abf7981843f6d
|
File details
Details for the file deped_geos-0.7.1-py3-none-any.whl.
File metadata
- Download URL: deped_geos-0.7.1-py3-none-any.whl
- Upload date:
- Size: 138.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5dc89b36a4a2ddbca34234a8ff3e7d4c8a87f0b0b671ba389a02b11b5c42983f
|
|
| MD5 |
fd06af352da996eb9c6e43fd6dea8839
|
|
| BLAKE2b-256 |
69343eadc6364de1f6f43bddcded701c8b5e8fd66abde47382d364c317c77529
|