buildstock-fetch 1.3.1__tar.gz → 1.4.0__tar.gz

{buildstock_fetch-1.3.1/buildstock_fetch.egg-info → buildstock_fetch-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildstock-fetch
-Version: 1.3.1
+Version: 1.4.0
 Summary: This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
 Author-email: Switchbox <hello@switch.box>
 Project-URL: Homepage, https://switchbox-data.github.io/buildstock-fetch/
@@ -24,6 +24,7 @@ Requires-Dist: typer>=0.9.0
 Requires-Dist: rich>=13.9.5
 Requires-Dist: questionary>=1.11.0
 Requires-Dist: polars>=0.20.0
+Requires-Dist: tomli>=2.0.0
 Provides-Extra: test
 Requires-Dist: pytest>=7.2.0; extra == "test"
 Provides-Extra: docs
@@ -44,6 +45,7 @@ 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"
+Requires-Dist: awscli>=1.32.0; extra == "dev-utils"
 Requires-Dist: xmltodict>=0.14.2; extra == "dev-utils"
 Provides-Extra: dev
 Requires-Dist: buildstock-fetch[dev-utils,docs,lint,test]; extra == "dev"
@@ -57,15 +59,36 @@ Dynamic: license-file
 [![Commit activity](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)
 [![License](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)
 
-This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
+A CLI tool, and python library, to simplify downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
 
 - **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
 - **Documentation**: <https://switchbox-data.github.io/buildstock-fetch/>
-- **PyPI page***: <https://pypi.org/project/buildstock-fetch/>
+- **PyPI page**: <https://pypi.org/project/buildstock-fetch/>
+
+## Installing the CLI tool
+
+We recommend using [uv](https://docs.astral.sh/uv/getting-started/installation/) or [pipx](https://pipx.pypa.io/stable/installation/) to install the buildstock-fetch CLI:
+
+```bash
+uv install buildstock-fetch
+```
+or
+
+```bash
+pipx install buildstock-fetch
+```
+
+You'll then be able to access the `bsf` command system-wide:
+
+```bash
+bsf --help
+```
 
 ## Installing the library
 
-`buildstock-fetch` is available on [PyPI](https://pypi.org/project/buildstock-fetch/) and can be installed via:
+buildstock-fetch is implemented in Python, and we expose our internal functions via a library.
+
+If you're using Python, and you want to install the CLI only for a particular project (rather than system-wide), or you want to user the underlying library, install our [PyPI](https://pypi.org/project/buildstock-fetch/) package via:
 
 ```bash
 pip install buildstock-fetch
@@ -77,26 +100,20 @@ or
 uv add buildstock-fetch
 ```
 
-## Using the library
+## Using the CLI
 
-To use the CLI tool in `buildstock-fetch` run:
+To make it easy to download what you want from NREL's S3 bucket, `bsf` has an interactive mode. Activate it with:
 
 ```bash
 bsf
 ```
 
-to activate the interactive mode. Alternatively, provide the inputs directly. For example,
+Alternatively, you can tell `bsf` exactly what to download via CLI args:
 
 ```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.3.1 → buildstock_fetch-1.4.0}/README.md

@@ -5,15 +5,36 @@
 [![Commit activity](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)](https://img.shields.io/github/commit-activity/m/switchbox-data/buildstock-fetch)
 [![License](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)](https://img.shields.io/github/license/switchbox-data/buildstock-fetch)
 
-This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
+A CLI tool, and python library, to simplify downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
 
 - **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
 - **Documentation**: <https://switchbox-data.github.io/buildstock-fetch/>
-- **PyPI page***: <https://pypi.org/project/buildstock-fetch/>
+- **PyPI page**: <https://pypi.org/project/buildstock-fetch/>
+
+## Installing the CLI tool
+
+We recommend using [uv](https://docs.astral.sh/uv/getting-started/installation/) or [pipx](https://pipx.pypa.io/stable/installation/) to install the buildstock-fetch CLI:
+
+```bash
+uv install buildstock-fetch
+```
+or
+
+```bash
+pipx install buildstock-fetch
+```
+
+You'll then be able to access the `bsf` command system-wide:
+
+```bash
+bsf --help
+```
 
 ## Installing the library
 
-`buildstock-fetch` is available on [PyPI](https://pypi.org/project/buildstock-fetch/) and can be installed via:
+buildstock-fetch is implemented in Python, and we expose our internal functions via a library.
+
+If you're using Python, and you want to install the CLI only for a particular project (rather than system-wide), or you want to user the underlying library, install our [PyPI](https://pypi.org/project/buildstock-fetch/) package via:
 
 ```bash
 pip install buildstock-fetch
@@ -25,26 +46,20 @@ or
 uv add buildstock-fetch
 ```
 
-## Using the library
+## Using the CLI
 
-To use the CLI tool in `buildstock-fetch` run:
+To make it easy to download what you want from NREL's S3 bucket, `bsf` has an interactive mode. Activate it with:
 
 ```bash
 bsf
 ```
 
-to activate the interactive mode. Alternatively, provide the inputs directly. For example,
+Alternatively, you can tell `bsf` exactly what to download via CLI args:
 
 ```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.3.1 → buildstock_fetch-1.4.0}/buildstock_fetch/data/buildstock_releases.json

@@ -8,12 +8,12 @@
       "0"
     ],
     "available_data": [
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "com_2021_tmy3_1": {
@@ -25,12 +25,12 @@
       "0"
     ],
     "available_data": [
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "res_2021_amy2018_1": {
@@ -42,12 +42,12 @@
       "0"
     ],
     "available_data": [
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "res_2021_tmy3_1": {
@@ -59,12 +59,12 @@
       "0"
     ],
     "available_data": [
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "res_2022_amy2012_1.1": {
@@ -86,15 +86,15 @@
       "10"
     ],
     "available_data": [
-      "load_curve_daily",
-      "load_curve_monthly",
-      "metadata",
+      "schedule",
       "load_curve_annual",
-      "weather",
+      "hpxml",
       "load_curve_15min",
+      "load_curve_daily",
       "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "weather",
+      "metadata"
     ]
   },
   "res_2022_amy2012_1": {
@@ -116,15 +116,15 @@
       "10"
     ],
     "available_data": [
-      "load_curve_daily",
-      "load_curve_monthly",
-      "metadata",
+      "schedule",
       "load_curve_annual",
-      "weather",
+      "hpxml",
       "load_curve_15min",
+      "load_curve_daily",
       "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "weather",
+      "metadata"
     ],
     "weather_map_available_states": [
       "NY"
@@ -149,14 +149,14 @@
       "10"
     ],
     "available_data": [
-      "load_curve_daily",
-      "load_curve_monthly",
-      "metadata",
+      "schedule",
       "load_curve_annual",
+      "hpxml",
       "load_curve_15min",
+      "load_curve_daily",
       "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "metadata"
     ]
   },
   "res_2022_amy2018_1": {
@@ -178,15 +178,15 @@
       "10"
     ],
     "available_data": [
-      "load_curve_daily",
-      "load_curve_monthly",
-      "metadata",
+      "schedule",
       "load_curve_annual",
-      "weather",
+      "hpxml",
       "load_curve_15min",
+      "load_curve_daily",
       "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "weather",
+      "metadata"
     ]
   },
   "res_2022_tmy3_1.1": {
@@ -208,15 +208,15 @@
       "10"
     ],
     "available_data": [
-      "load_curve_daily",
-      "load_curve_monthly",
-      "metadata",
+      "schedule",
       "load_curve_annual",
-      "weather",
+      "hpxml",
       "load_curve_15min",
+      "load_curve_daily",
       "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "weather",
+      "metadata"
     ]
   },
   "res_2022_tmy3_1": {
@@ -238,15 +238,15 @@
       "10"
     ],
     "available_data": [
-      "load_curve_daily",
-      "load_curve_monthly",
-      "metadata",
+      "schedule",
       "load_curve_annual",
-      "weather",
+      "hpxml",
       "load_curve_15min",
+      "load_curve_daily",
       "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "weather",
+      "metadata"
     ]
   },
   "com_2023_amy2018_1": {
@@ -268,13 +268,13 @@
       "10"
     ],
     "available_data": [
+      "load_curve_annual",
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
-      "load_curve_annual",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "com_2023_amy2018_2": {
@@ -304,13 +304,13 @@
       "18"
     ],
     "available_data": [
+      "load_curve_annual",
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
-      "load_curve_annual",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "com_2024_amy2018_1": {
@@ -353,13 +353,13 @@
       "32"
     ],
     "available_data": [
+      "load_curve_annual",
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
-      "load_curve_annual",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "com_2024_amy2018_2": {
@@ -410,13 +410,13 @@
       "39"
     ],
     "available_data": [
+      "load_curve_annual",
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
-      "load_curve_annual",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "res_2024_amy2018_2": {
@@ -444,18 +444,19 @@
       "16"
     ],
     "available_data": [
+      "hpxml",
+      "load_curve_15min",
       "load_curve_daily",
-      "load_curve_monthly",
+      "load_curve_hourly",
       "metadata",
+      "schedule",
       "load_curve_annual",
-      "load_curve_15min",
       "weather",
-      "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "trip_schedules"
     ],
-    "weather_map_available_states": [
-      "AZ"
+    "trip_schedule_states": [
+      "NY"
     ]
   },
   "res_2024_tmy3_1": {
@@ -491,17 +492,18 @@
       "16"
     ],
     "available_data": [
+      "hpxml",
+      "load_curve_15min",
       "load_curve_daily",
-      "load_curve_monthly",
+      "load_curve_hourly",
       "metadata",
+      "schedule",
       "load_curve_annual",
-      "load_curve_15min",
       "weather",
-      "load_curve_hourly",
-      "hpxml",
-      "schedule"
+      "load_curve_monthly",
+      "trip_schedules"
     ],
-    "weather_map_available_states": [
+    "trip_schedule_states": [
       "NY"
     ]
   },
@@ -571,13 +573,13 @@
       "57"
     ],
     "available_data": [
+      "load_curve_annual",
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
-      "load_curve_annual",
       "weather",
-      "load_curve_15min",
-      "load_curve_hourly"
+      "metadata"
     ]
   },
   "com_2025_amy2018_2": {
@@ -650,13 +652,61 @@
       "61"
     ],
     "available_data": [
+      "load_curve_annual",
+      "load_curve_15min",
       "load_curve_daily",
+      "load_curve_hourly",
       "load_curve_monthly",
-      "metadata",
-      "load_curve_annual",
       "weather",
+      "metadata"
+    ]
+  },
+  "res_2025_amy2018_1": {
+    "release_year": "2025",
+    "res_com": "resstock",
+    "weather": "amy2018",
+    "release_number": "1",
+    "upgrade_ids": [
+      "0",
+      "1",
+      "2",
+      "3",
+      "4",
+      "5",
+      "6",
+      "7",
+      "8",
+      "9",
+      "10",
+      "11",
+      "12",
+      "13",
+      "14",
+      "15",
+      "16",
+      "17",
+      "18",
+      "19",
+      "20",
+      "21",
+      "22",
+      "23",
+      "24",
+      "25",
+      "26",
+      "27",
+      "28"
+    ],
+    "available_data": [
+      "schedule",
+      "load_curve_annual",
+      "hpxml",
       "load_curve_15min",
-      "load_curve_hourly"
+      "load_curve_daily",
+      "load_curve_hourly",
+      "load_curve_monthly",
+      "weather",
+      "metadata"
     ]
   }
 }