Skip to content

docs: sentier-inventory organised by source folder, sector as a column - #1

Merged
lbougan merged 1 commit into
mainfrom
docs/inventory-source-folders
Oct 12, 2026
Merged

lbougan merged 1 commit into
mainfrom
docs/inventory-source-folders

Conversation

@lbougan

@lbougan lbougan commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the sentier-inventory layout change: one folder per published release of one datasource (data/bafu-2026-v1/), sector as a column, per-source metadata.json (schema 0.3.0). Follows the three code PRs, which are open and not yet merged:

Why the change: a delivery from sentier-importers copied its sector file over the existing one, so a second source delivered into a sector folder would have erased the rows there. Sources now never share a file.

Changes

  • sentier/modules/sentier-inventory/*: layout, datasets, classes, commands, gotchas, status, README and both use cases rewritten for schema 0.3.0; read-a-sector-folder-with-pandas renamed to read-a-source-folder-with-pandas, links updated. Use cases re-run on 2026-10-12 against cf54f55.
  • sentier/modules/sentier-brightway/*: loader signature load_inventory(data_root, source, source_version=None), --source-version on the CLI, sector node tag, pin cf54f55.
  • sentier/modules/sentier-importers/*: 46 registry sources, bafu-processes / bafu-exchanges blocks with category bafu-2026-v1, SOURCE_FOLDER, bare sector ids.
  • core/sectors/* and core/use-cases/*: wiki sectors now map onto sector column values instead of rank-prefixed folders; crosswalk rewritten.
  • Root: index.md, vocabulary.md (new "Source folder" term, "Sector folder" marked as the pre-0.3.0 layout), sources.md (three PR rows), SPECS.md, sentier/README.md, sentier/commands.md, bafu/README.md, bafu/data/fetch.md.

Checks

  • 0 broken relative links or related: targets; every sources: id and (source: ...) marker resolves
  • index summaries match page frontmatter; no page over 400 lines
  • remaining mentions of the old folder names are deliberate history notes

Merge after the three code PRs.

@lbougan
lbougan merged commit 9c707cc into main Oct 12, 2026
@lbougan
lbougan deleted the docs/inventory-source-folders branch October 12, 2026 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant