Skip to content

Commit 36f158f

Browse files
committed
Refactor package layout and fix uv build
1 parent 0199526 commit 36f158f

30 files changed

+34
-24
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ __pycache__/
77

88
# Local data and outputs
99
data/
10+
rate_design/ny/hp_rates/data/buildstock_raw/
11+
rate_design/ny/hp_rates/data/buildstock_processed/
12+
rate_design/ny/hp_rates/data/cairo_cases/
1013
outputs/
1114
site/
1215

LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Placeholder license. Replace with the appropriate license text for this project.

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@ This repository is a clean scaffold for rate design analysis, focused on New Yor
44

55
## Layout
66

7-
- `src/rate_design/` — package skeleton for shared logic, utilities, and New York–specific code.
8-
- `data/ny/` — local cache for BuildStock and CAIRO inputs/outputs (kept out of git).
9-
- `scripts/` — helper scripts (e.g., running a NY heat pump rate scenario).
10-
- `tests/` — placeholder test files to fill in alongside new code.
7+
- `rate_design/` — package root.
8+
- `ny/hp_rates/`
9+
- `data/` — local inputs/outputs; `buildstock_*` and `cairo_cases/` are git-ignored. Configs under `tariff_structure/` and `tariff_mapping/` stay versioned.
10+
- `scenarios/` — YAML configs selecting tariffs/mappings and other simulation parameters.
11+
- `scripts/` — helpers such as customer selection, tariff builders, and case path helpers.
12+
- `Justfile` — NY HP-specific recipes (stub).
13+
- `ny/ev_rates/` — stubbed EV structure (data, scenarios, scripts, Justfile).
14+
- `utils/` — cross-jurisdiction utilities (buildstock IO, S3 sync, conversions).
15+
- `tests/` — placeholder test files to expand alongside code.
1116

1217
## Notes
13-
- Data under `data/` should remain local or synced via S3 tooling you add; keep large artifacts out of git.
18+
- Data under `rate_design/ny/hp_rates/data/` (buildstock raw/processed, cairo cases) should remain local or synced via S3 tooling you add; keep large artifacts out of git.

pyproject.toml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description = "Skeleton for the rate design platform."
55
readme = "README.md"
66
requires-python = ">=3.11"
77
authors = [{ name = "Switchbox Data" }]
8-
license = { file = "LICENSE" }
8+
license = "LicenseRef-Proprietary"
99
dependencies = [
1010
"buildstock-fetch",
1111
"cairo",
@@ -22,11 +22,18 @@ requires = ["setuptools>=61.0"]
2222
build-backend = "setuptools.build_meta"
2323

2424
[tool.setuptools]
25-
package-dir = { "" = "src" }
25+
package-dir = { "" = "." }
2626

2727
[tool.setuptools.packages.find]
28-
where = ["src"]
29-
include = ["rate_design*"]
28+
where = ["."]
29+
include = ["rate_design*", "utils*"]
30+
31+
[tool.setuptools.package-data]
32+
"rate_design.ny.hp_rates" = [
33+
"scenarios/*.yaml",
34+
"data/tariff_structure/*.json",
35+
"data/tariff_mapping/*.csv",
36+
]
3037

3138
[tool.uv.sources]
3239
cairo = { git = "https://github.com/NREL/CAIRO.git", rev = "tb/dev_package" }

rate_design/ny/hp_rates/Justfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# NY heat pump tasks (placeholder).
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)