buildstock-fetch 1.0.2__tar.gz → 1.0.4__tar.gz

buildstock_fetch-1.0.4/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include buildstock_fetch/data *.json
+recursive-include buildstock_fetch/data/building_data *

{buildstock_fetch-1.0.2/buildstock_fetch.egg-info → buildstock_fetch-1.0.4}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: buildstock-fetch
-Version: 1.0.2
+Version: 1.0.4
 Summary: This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
-Author-email: Switchbox <bryan@switch.box>
+Author-email: Switchbox <hello@switch.box>
 Project-URL: Homepage, https://switchbox-data.github.io/buildstock-fetch/
 Project-URL: Repository, https://github.com/switchbox-data/buildstock-fetch
 Project-URL: Documentation, https://switchbox-data.github.io/buildstock-fetch/
@@ -23,12 +23,30 @@ Requires-Dist: requests>=2.32.3
 Requires-Dist: typer>=0.9.0
 Requires-Dist: rich>=13.9.5
 Requires-Dist: questionary>=1.11.0
-Requires-Dist: pandas>=2.0.0
-Requires-Dist: boto3>=1.33.0
-Requires-Dist: botocore>=1.33.0
-Requires-Dist: pyarrow>=14.0.1
 Requires-Dist: polars>=0.20.0
-Requires-Dist: numpy>=1.26.4
+Provides-Extra: test
+Requires-Dist: pytest>=7.2.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.4.2; extra == "docs"
+Requires-Dist: mkdocs-material>=8.5.10; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26.1; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: pre-commit>=2.20.0; extra == "lint"
+Requires-Dist: mypy>=0.991; extra == "lint"
+Requires-Dist: ruff>=0.11.5; extra == "lint"
+Requires-Dist: deptry>=0.23.0; extra == "lint"
+Requires-Dist: types-requests>=2.31.0; extra == "lint"
+Requires-Dist: types-boto3>=1.33.0; extra == "lint"
+Requires-Dist: pandas-stubs>=2.2.0; extra == "lint"
+Provides-Extra: dev-utils
+Requires-Dist: boto3>=1.33.0; extra == "dev-utils"
+Requires-Dist: botocore>=1.33.0; extra == "dev-utils"
+Requires-Dist: pyarrow>=14.0.1; extra == "dev-utils"
+Requires-Dist: numpy>=1.26.4; extra == "dev-utils"
+Requires-Dist: scikit-learn>=1.6.1; extra == "dev-utils"
+Provides-Extra: dev
+Requires-Dist: buildstock-fetch[dev-utils,docs,lint,test]; extra == "dev"
+Requires-Dist: tox-uv>=1.11.3; extra == "dev"
 Dynamic: license-file
 
 # buildstock-fetch
@@ -43,9 +61,9 @@ This library simplifies downloading building characteristics and load curve data
 - **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
 - **Documentation** <https://switchbox-data.github.io/buildstock-fetch/>
 
-## Using the library
+## Installing the library
 
-`buildstock-fetch` is available on PyPI and can be installed via:
+`buildstock-fetch` is available on [PyPI](https://pypi.org/project/buildstock-fetch/) and can be installed via:
 
 ```bash
 pip install buildstock-fetch
@@ -54,9 +72,30 @@ pip install buildstock-fetch
 or
 
 ```bash
-uv pip install buildstock-fetch
+uv add buildstock-fetch
+```
+
+## Using the library
+
+To use the CLI tool in `buildstock-fetch` run:
+
+```bash
+bsf
+```
+
+to activate the interactive mode. Alternatively, provide the inputs directly. For example,
+
+```bash
+bsf --product resstock --release_year 2022 --weather_file tmy3 --release_version 1 --states CA --file_type "hpxml metadata" --upgrade_id "0 1 2" --output_directory ./CA_data
+```
+
+If the above options don't work, try:
+
+```bash
+python -m buildstock_fetch
 ```
 
+For more details about the usage, see [Usage](https://switchbox-data.github.io/buildstock-fetch/usage/)
 
 ## Developing the library
 

{buildstock_fetch-1.0.2 → buildstock_fetch-1.0.4}/README.md

@@ -10,9 +10,9 @@ This library simplifies downloading building characteristics and load curve data
 - **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
 - **Documentation** <https://switchbox-data.github.io/buildstock-fetch/>
 
-## Using the library
+## Installing the library
 
-`buildstock-fetch` is available on PyPI and can be installed via:
+`buildstock-fetch` is available on [PyPI](https://pypi.org/project/buildstock-fetch/) and can be installed via:
 
 ```bash
 pip install buildstock-fetch
@@ -21,9 +21,30 @@ pip install buildstock-fetch
 or
 
 ```bash
-uv pip install buildstock-fetch
+uv add buildstock-fetch
+```
+
+## Using the library
+
+To use the CLI tool in `buildstock-fetch` run:
+
+```bash
+bsf
+```
+
+to activate the interactive mode. Alternatively, provide the inputs directly. For example,
+
+```bash
+bsf --product resstock --release_year 2022 --weather_file tmy3 --release_version 1 --states CA --file_type "hpxml metadata" --upgrade_id "0 1 2" --output_directory ./CA_data
+```
+
+If the above options don't work, try:
+
+```bash
+python -m buildstock_fetch
 ```
 
+For more details about the usage, see [Usage](https://switchbox-data.github.io/buildstock-fetch/usage/)
 
 ## Developing the library
 

{buildstock_fetch-1.0.2/buildstock_fetch/utils → buildstock_fetch-1.0.4/buildstock_fetch/data}/buildstock_releases.json

@@ -8,12 +8,11 @@
       "0"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly"
     ]
   },
   "com_2021_tmy3_1": {
@@ -25,12 +24,11 @@
       "0"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly"
     ]
   },
   "res_2021_amy2018_1": {
@@ -42,12 +40,11 @@
       "0"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly"
     ]
   },
   "res_2021_tmy3_1": {
@@ -59,12 +56,11 @@
       "0"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly"
     ]
   },
   "res_2022_amy2012_1.1": {
@@ -86,14 +82,14 @@
       "10"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "hpxml",
       "schedule",
       "load_curve_daily",
-      "metadata",
+      "load_curve_15min",
+      "hpxml",
       "load_curve_hourly",
-      "load_curve_15min"
+      "metadata",
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "res_2022_amy2012_1": {
@@ -115,14 +111,14 @@
       "10"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "hpxml",
       "schedule",
       "load_curve_daily",
-      "metadata",
+      "load_curve_15min",
+      "hpxml",
       "load_curve_hourly",
-      "load_curve_15min"
+      "metadata",
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "res_2022_amy2018_1.1": {
@@ -144,14 +140,14 @@
       "10"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "hpxml",
       "schedule",
       "load_curve_daily",
-      "metadata",
+      "load_curve_15min",
+      "hpxml",
       "load_curve_hourly",
-      "load_curve_15min"
+      "metadata",
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "res_2022_amy2018_1": {
@@ -173,14 +169,14 @@
       "10"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "hpxml",
       "schedule",
       "load_curve_daily",
-      "metadata",
+      "load_curve_15min",
+      "hpxml",
       "load_curve_hourly",
-      "load_curve_15min"
+      "metadata",
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "res_2022_tmy3_1.1": {
@@ -202,14 +198,14 @@
       "10"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "hpxml",
       "schedule",
       "load_curve_daily",
-      "metadata",
+      "load_curve_15min",
+      "hpxml",
       "load_curve_hourly",
-      "load_curve_15min"
+      "metadata",
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "res_2022_tmy3_1": {
@@ -231,14 +227,14 @@
       "10"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "hpxml",
       "schedule",
       "load_curve_daily",
-      "metadata",
+      "load_curve_15min",
+      "hpxml",
       "load_curve_hourly",
-      "load_curve_15min"
+      "metadata",
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "com_2023_amy2018_1": {
@@ -260,12 +256,12 @@
       "10"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "com_2023_amy2018_2": {
@@ -295,12 +291,12 @@
       "18"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "com_2024_amy2018_1": {
@@ -343,12 +339,12 @@
       "32"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "com_2024_amy2018_2": {
@@ -399,12 +395,12 @@
       "39"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   },
   "res_2024_amy2018_2": {
@@ -432,12 +428,14 @@
       "16"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "load_curve_daily",
+      "hpxml",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_daily",
+      "load_curve_annual",
+      "load_curve_monthly",
+      "schedule"
     ]
   },
   "res_2024_tmy3_1": {
@@ -446,9 +444,7 @@
     "weather": "tmy3",
     "release_number": "1",
     "upgrade_ids": [],
-    "available_data": [
-      "metadata"
-    ]
+    "available_data": []
   },
   "res_2024_tmy3_2": {
     "release_year": "2024",
@@ -475,12 +471,14 @@
       "16"
     ],
     "available_data": [
-      "load_curve_monthly",
-      "load_curve_annual",
-      "load_curve_daily",
+      "hpxml",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_daily",
+      "load_curve_annual",
+      "load_curve_monthly",
+      "schedule"
     ]
   },
   "com_2025_amy2018_1": {
@@ -549,12 +547,27 @@
       "57"
     ],
     "available_data": [
+      "load_curve_daily",
+      "load_curve_15min",
+      "load_curve_hourly",
+      "metadata",
       "load_curve_monthly",
-      "load_curve_annual",
+      "load_curve_annual"
+    ]
+  },
+  "com_2025_amy2018_2": {
+    "release_year": "2025",
+    "res_com": "comstock",
+    "weather": "amy2018",
+    "release_number": "2",
+    "upgrade_ids": [],
+    "available_data": [
       "load_curve_daily",
+      "load_curve_15min",
       "load_curve_hourly",
       "metadata",
-      "load_curve_15min"
+      "load_curve_monthly",
+      "load_curve_annual"
     ]
   }
 }