Skip to content

Rename NREL to NLR (National Laboratory of the Rockies) in docs/prose - #40

Merged
nllong merged 1 commit into
feat/ensemble-building-typesfrom
chore/rename-nrel-to-nlr
Jul 29, 2026
Merged

Rename NREL to NLR (National Laboratory of the Rockies) in docs/prose#40
nllong merged 1 commit into
feat/ensemble-building-typesfrom
chore/rename-nrel-to-nlr

Conversation

@nllong

@nllong nllong commented Jul 28, 2026

Copy link
Copy Markdown
Member

Summary

Renames organizational-name references from "NREL" to "NLR" (National Laboratory of the Rockies) throughout module docstrings, comments, and README.md, following the org's rebrand.

Stacked on #39 (composite building types) — this branches off feat/ensemble-building-types since it touches several of the same shared files (README.md, __init__.py). Please merge #39 first.

What's changed vs. what's intentionally left alone

  • Renamed: prose/attribution text describing who publishes ComStock/ResStock (module docstrings in _base.py, comstock.py, resstock.py, __init__.py, README.md, pyproject.toml description)
  • Left unchanged (intentionally): the literal nrel-pds-building-stock S3 bucket/path prefix used in real OEDI data lake download URLs (in comstock.py, resstock.py, README.md's Base URL/Data Explorer links, and the corresponding test assertions in tests/test_comstock_processor.py/tests/test_resstock_processor.py). These are real, hardcoded AWS paths — not branding text — so renaming them would break every metadata/time-series download.
  • cspell.json: added "NLR" to the allowlist; kept "NREL" since it still appears in the literal bucket paths.

Testing

  • uv run pytest — all tests pass (confirms the real download URLs still work)
  • uv run mypy — clean
  • uv run pre-commit run --all-files — clean

🤖 Generated with Copilot CLI

@nllong
nllong force-pushed the feat/ensemble-building-types branch from 669afeb to ff92136 Compare July 28, 2026 13:50
…s/prose

Renames organizational-name references from "NREL" to "NLR" (National
Laboratory of the Rockies) throughout module docstrings, comments, README.md,
and the ENERGY STAR crosswalk docs, following the org's rebrand.

Literal, hardcoded S3 bucket/path segments (e.g. the "nrel-pds-building-stock"
prefix in real OEDI data lake URLs) are intentionally left unchanged, since
those are real AWS paths, not branding text -- renaming them would break every
metadata/time-series download. Test assertions checking those exact URLs are
also left unchanged. Added "NLR" to cspell.json's allowlist (kept "NREL" too,
since it still appears in the literal bucket paths).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@nllong
nllong force-pushed the chore/rename-nrel-to-nlr branch from 39c1ba0 to a7b4124 Compare July 28, 2026 13:51
@nllong
nllong merged commit 059550b into feat/ensemble-building-types Jul 29, 2026
3 checks passed
@nllong
nllong deleted the chore/rename-nrel-to-nlr branch July 29, 2026 13:05
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