Feature/add structured metadata - #22
Merged
Merged
Conversation
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
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.
This pull request introduces several important improvements and clarifications to the local subset metadata analysis workflow, S3 table configuration, and domain terminology. The main themes are: (1) clarifying the canonical use of "Facility" vs "collection" in domain language and code, (2) adding new local subset and analysis handoff documentation, (3) updating configuration and defaults for local and subset indexing, and (4) providing new developer documentation for S3 table management.
Domain terminology and schema clarifications:
CONTEXT.mdto clarify that "Facility" is now the canonical term for the second S3 path segment (e.g.,IMOS/ANMN/NSW/file.nc), whilecollectionis retained only as a legacy field/schema name for backward compatibility. All relevant glossary, ambiguity, and schema sections were updated to reflect this, and ambiguity between "collection" and "facility" is now explicitly resolved. [1] [2] [3] [4]Local subset pipeline and configuration:
local_subset.pythat defines a local subset pipeline usingLiveS3InventorySourceFacilitySubset, with explicit configuration for inventory, sinks, and a threshold-based fetcher. This enables targeted facility-based sampling for local analysis.local.pyto use the canonicalAttributeNetCDFExtractorby default, updated variable names for clarity, and tuned worker/thread settings for local runs. [1] [2]Analysis and handoff documentation:
2026-06-02-local-subset-metadata-analysis.md: Outlines the analysis design, metrics, glossary decisions, and concrete next steps for evaluating facility extraction, structured field coverage, and unstructured mapping correctness.2026-06-02-structured-metadata-schema-feedback.md: Documents stakeholder feedback and decisions for upcoming schema changes, including new fields, alias handling, and test requirements.Developer documentation and analysis support:
managing-s3-tables.mddocumenting how to delete S3 tables and table buckets using the AWS CLI, supporting easier management of Iceberg tables.analysis/structured_metadata/v1.ipynb) to demonstrate configuration and usage of Iceberg table configs for structured and unstructured metadata.genson,natsort) topyproject.tomlto support schema generation and sorting in analysis scripts.Summary of most important changes:
1. Domain terminology and schema updates
2. Local subset pipeline and configuration
local_subset.pyfor facility-based local subset indexing, with explicit configuration for inventory, sinks, and fetcher.local.pyto default toAttributeNetCDFExtractor, improved naming, and tuned worker/thread settings for local development. [1] [2]3. Analysis and handoff documentation
4. Developer and analysis support