Metadata-Version: 2.1
Name: doe-xstock
Version: 1.1.0
Summary: Manage DOE's End Use Load Profiles for the U.S. Building Stock.
Home-page: https://github.com/intelligent-environments-lab/doe_xstock
Author: Kingsley Nweye
Author-email: etonwana@yahoo.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: beautifulsoup4
Requires-Dist: eppy
Requires-Dist: pandas
Requires-Dist: platformdirs
Requires-Dist: pyarrow
Requires-Dist: openstudio<=3.3.0
Requires-Dist: requests
Requires-Dist: simplejson

# DOE XStock
## Description
This repository is used to manage the [End Use Load Profiles for the U.S. Building Stock](https://www.nrel.gov/buildings/end-use-load-profiles.html) dataset by providing an _Pythonic_ interface to download the [dataset files](https://data.openei.org/s3_viewer?bucket=oedi-data-lake&prefix=nrel-pds-building-stock%2Fend-use-load-profiles-for-us-building-stock%2F) as well as run EnergyPlus simulations on the contained OSM models. Refer to the [README.md](https://data.openei.org/s3_viewer?bucket=oedi-data-lake&prefix=nrel-pds-building-stock%2Fend-use-load-profiles-for-us-building-stock%2F) for more details on the full dataset.

## Installation

To install the Python package, execute:
```console
pip install doe_xstock
```

# Documentation
Coming soon :).
