# rewiringamerica-rem
An API for REM, the Residential Electrification Model.
The other Rewiring America APIs and methodology for REM are [here](https://api.rewiringamerica.org/).
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.0
- Package version: 0.3.0
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.rewiringamerica.org/](https://www.rewiringamerica.org/)
## Requirements.
Python 3.8+
## Installation & Usage
### pip install
Run:
```sh
pip install rewiringamerica-rem
```
Then import the package:
```python
import rewiringamerica_rem
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import rewiringamerica_rem
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import rewiringamerica_rem
from rewiringamerica_rem.models.heating_fuel_input import HeatingFuelInput
from rewiringamerica_rem.models.savings import Savings
from rewiringamerica_rem.models.supported_upgrade import SupportedUpgrade
from rewiringamerica_rem.rest import ApiException
from pprint import pprint
import os
# Defining the host is optional and defaults to https://api.rewiringamerica.org
# See configuration.py for a list of all supported configuration parameters.
configuration = rewiringamerica_rem.Configuration(
host = "https://api.rewiringamerica.org"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: auth
configuration = rewiringamerica_rem.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with rewiringamerica_rem.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rewiringamerica_rem.ResidentialElectrificationModelApi(api_client)
upgrade = rewiringamerica_rem.SupportedUpgrade() # SupportedUpgrade | The upgrade whose effects we want to analyze. Supported values are as follows: - `basic_enclosure`: A basic weatherization upgrade for the home as described in measure package 1 (on page 4) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `min_eff_hp_elec_backup`: A relatively-low efficiency heat pump upgrade for the home’s HVAC system as described in measure package 3 (on page 5) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `high_eff_hp_elec_backup`: A high efficiency heat pump upgrade for the home’s HVAC system as described in measure package 4 (on page 6) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `whole_home_electric_max_eff_basic_enclosure`: A whole-home upgrade including a high efficiency heat pump for the home’s HVAC system, basic weatherization, a heat pump water heater, a heat pump dryer, and an induction stove as described in measure package 9 (on page 9) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `med_eff_hp_hers_sizing_no_setback`: A medium-efficiency heat pump upgrade for the home's HVAC system. Rewiring America simulated this upgrade using the same tools NREL uses for ResStock. - `med_eff_hp_hers_sizing_no_setback_basic_enclosure`: A custom upgrade based on a medium-efficiency heat pump and basic weatherization upgrade for the home. Rewiring America simulated this upgrade using the same tools NREL uses for ResStock.
address = 'address_example' # str | The address of the home being upgraded.
heating_fuel = rewiringamerica_rem.HeatingFuelInput() # HeatingFuelInput | The heating fuel used in the home before the upgrade. Supported values are as follows: - `electricity`: the home was heated with electric heating, such as baseboard heating, an electric boiler, or an electric furnace. - `natural_gas`: The home was heated with a natural gas furnace. - `fuel_oil`: The home was heated with a fuel oil boiler or furnace. - `propane`: The home was heated with a propane furnace.
try:
# Get By Address
api_response = api_instance.get_by_address(upgrade, address, heating_fuel)
print("The response of ResidentialElectrificationModelApi->get_by_address:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ResidentialElectrificationModelApi->get_by_address: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.rewiringamerica.org*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BuildingProfilerApi* | [**get_home_profile**](docs/BuildingProfilerApi.md#get_home_profile) | **GET** /api/v1/building_profiler/home | Get Home Profile
*ResidentialElectrificationModelApi* | [**get_by_address**](docs/ResidentialElectrificationModelApi.md#get_by_address) | **GET** /api/v1/rem/address | Get By Address
*ResidentialElectrificationModelApi* | [**get_by_profile**](docs/ResidentialElectrificationModelApi.md#get_by_profile) | **POST** /api/v1/rem/profile | Get By Profile
*ResidentialElectrificationModelApi* | [**get_impl_version**](docs/ResidentialElectrificationModelApi.md#get_impl_version) | **GET** /api/v1/rem/server_version | Get Impl Version
## Documentation For Models
- [BuildingFeatures](docs/BuildingFeatures.md)
- [BuildingProfile](docs/BuildingProfile.md)
- [FuelRate](docs/FuelRate.md)
- [FuelSavings](docs/FuelSavings.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [HeatingFuelInput](docs/HeatingFuelInput.md)
- [HeatingFuelOutput](docs/HeatingFuelOutput.md)
- [ImpactMetric](docs/ImpactMetric.md)
- [MetricStatistics](docs/MetricStatistics.md)
- [Quantity](docs/Quantity.md)
- [RemProfileRequest](docs/RemProfileRequest.md)
- [ResultFuelType](docs/ResultFuelType.md)
- [Savings](docs/Savings.md)
- [SupportedUpgrade](docs/SupportedUpgrade.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Sign up for an API key [here](https://homes.rewiringamerica.org/api/developer-login).
Authentication schemes defined for the API:
<a id="auth"></a>
### auth
- **Type**: Bearer authentication
## Author
datascience@rewiringamerica.org
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "rewiringamerica-rem",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Residential Electrification Model API",
"author": "Rewiring America",
"author_email": "datascience@rewiringamerica.org",
"download_url": "https://files.pythonhosted.org/packages/6a/7e/a4ed82d64606c0a7a9d54141970461bcf90006c3ff0ffb106552b216b9c2/rewiringamerica_rem-0.3.0.tar.gz",
"platform": null,
"description": "# rewiringamerica-rem\nAn API for REM, the Residential Electrification Model.\n The other Rewiring America APIs and methodology for REM are [here](https://api.rewiringamerica.org/).\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.0\n- Package version: 0.3.0\n- Generator version: 7.10.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\nFor more information, please visit [https://www.rewiringamerica.org/](https://www.rewiringamerica.org/)\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n### pip install\n\nRun:\n\n```sh\npip install rewiringamerica-rem\n```\n\n\nThen import the package:\n```python\nimport rewiringamerica_rem\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport rewiringamerica_rem\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport rewiringamerica_rem\nfrom rewiringamerica_rem.models.heating_fuel_input import HeatingFuelInput\nfrom rewiringamerica_rem.models.savings import Savings\nfrom rewiringamerica_rem.models.supported_upgrade import SupportedUpgrade\nfrom rewiringamerica_rem.rest import ApiException\nfrom pprint import pprint\nimport os\n\n# Defining the host is optional and defaults to https://api.rewiringamerica.org\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = rewiringamerica_rem.Configuration(\n host = \"https://api.rewiringamerica.org\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: auth\nconfiguration = rewiringamerica_rem.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n# Enter a context with an instance of the API client\nwith rewiringamerica_rem.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = rewiringamerica_rem.ResidentialElectrificationModelApi(api_client)\n upgrade = rewiringamerica_rem.SupportedUpgrade() # SupportedUpgrade | The upgrade whose effects we want to analyze. Supported values are as follows: - `basic_enclosure`: A basic weatherization upgrade for the home as described in measure package 1 (on page 4) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `min_eff_hp_elec_backup`: A relatively-low efficiency heat pump upgrade for the home\u2019s HVAC system as described in measure package 3 (on page 5) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `high_eff_hp_elec_backup`: A high efficiency heat pump upgrade for the home\u2019s HVAC system as described in measure package 4 (on page 6) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `whole_home_electric_max_eff_basic_enclosure`: A whole-home upgrade including a high efficiency heat pump for the home\u2019s HVAC system, basic weatherization, a heat pump water heater, a heat pump dryer, and an induction stove as described in measure package 9 (on page 9) of [this document](https://oedi-data-lake.s3.amazonaws.com/nrel-pds-building-stock/end-use-load-profiles-for-us-building-stock/2022/EUSS_ResRound1_Technical_Documentation.pdf). - `med_eff_hp_hers_sizing_no_setback`: A medium-efficiency heat pump upgrade for the home's HVAC system. Rewiring America simulated this upgrade using the same tools NREL uses for ResStock. - `med_eff_hp_hers_sizing_no_setback_basic_enclosure`: A custom upgrade based on a medium-efficiency heat pump and basic weatherization upgrade for the home. Rewiring America simulated this upgrade using the same tools NREL uses for ResStock. \n address = 'address_example' # str | The address of the home being upgraded.\n heating_fuel = rewiringamerica_rem.HeatingFuelInput() # HeatingFuelInput | The heating fuel used in the home before the upgrade. Supported values are as follows: - `electricity`: the home was heated with electric heating, such as baseboard heating, an electric boiler, or an electric furnace. - `natural_gas`: The home was heated with a natural gas furnace. - `fuel_oil`: The home was heated with a fuel oil boiler or furnace. - `propane`: The home was heated with a propane furnace. \n\n try:\n # Get By Address\n api_response = api_instance.get_by_address(upgrade, address, heating_fuel)\n print(\"The response of ResidentialElectrificationModelApi->get_by_address:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ResidentialElectrificationModelApi->get_by_address: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.rewiringamerica.org*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BuildingProfilerApi* | [**get_home_profile**](docs/BuildingProfilerApi.md#get_home_profile) | **GET** /api/v1/building_profiler/home | Get Home Profile\n*ResidentialElectrificationModelApi* | [**get_by_address**](docs/ResidentialElectrificationModelApi.md#get_by_address) | **GET** /api/v1/rem/address | Get By Address\n*ResidentialElectrificationModelApi* | [**get_by_profile**](docs/ResidentialElectrificationModelApi.md#get_by_profile) | **POST** /api/v1/rem/profile | Get By Profile\n*ResidentialElectrificationModelApi* | [**get_impl_version**](docs/ResidentialElectrificationModelApi.md#get_impl_version) | **GET** /api/v1/rem/server_version | Get Impl Version\n\n\n## Documentation For Models\n\n - [BuildingFeatures](docs/BuildingFeatures.md)\n - [BuildingProfile](docs/BuildingProfile.md)\n - [FuelRate](docs/FuelRate.md)\n - [FuelSavings](docs/FuelSavings.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [HeatingFuelInput](docs/HeatingFuelInput.md)\n - [HeatingFuelOutput](docs/HeatingFuelOutput.md)\n - [ImpactMetric](docs/ImpactMetric.md)\n - [MetricStatistics](docs/MetricStatistics.md)\n - [Quantity](docs/Quantity.md)\n - [RemProfileRequest](docs/RemProfileRequest.md)\n - [ResultFuelType](docs/ResultFuelType.md)\n - [Savings](docs/Savings.md)\n - [SupportedUpgrade](docs/SupportedUpgrade.md)\n - [ValidationError](docs/ValidationError.md)\n - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nSign up for an API key [here](https://homes.rewiringamerica.org/api/developer-login).\n\nAuthentication schemes defined for the API:\n<a id=\"auth\"></a>\n### auth\n\n- **Type**: Bearer authentication\n\n\n## Author\n\ndatascience@rewiringamerica.org\n\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Residential Electrification Model API",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" residential electrification model api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41ef19cafadd2076ce9babe9fc8779833d489619e8dd4a861f633e4c845b9966",
"md5": "5eaf413212bd392fccf0c947abee3e90",
"sha256": "9b294379fc54e8b19269d4befc18c6bbf6330fd006808a75cd17c37d11cd7e62"
},
"downloads": -1,
"filename": "rewiringamerica_rem-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5eaf413212bd392fccf0c947abee3e90",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 52302,
"upload_time": "2024-12-13T20:13:17",
"upload_time_iso_8601": "2024-12-13T20:13:17.405718Z",
"url": "https://files.pythonhosted.org/packages/41/ef/19cafadd2076ce9babe9fc8779833d489619e8dd4a861f633e4c845b9966/rewiringamerica_rem-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6a7ea4ed82d64606c0a7a9d54141970461bcf90006c3ff0ffb106552b216b9c2",
"md5": "00a6af85b5ca2a72819e7ec377f81b2d",
"sha256": "54dd11d3d48682880602e79b9ba173c7781656eff29faa0f22fa0a25aab17420"
},
"downloads": -1,
"filename": "rewiringamerica_rem-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "00a6af85b5ca2a72819e7ec377f81b2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 32935,
"upload_time": "2024-12-13T20:13:19",
"upload_time_iso_8601": "2024-12-13T20:13:19.774935Z",
"url": "https://files.pythonhosted.org/packages/6a/7e/a4ed82d64606c0a7a9d54141970461bcf90006c3ff0ffb106552b216b9c2/rewiringamerica_rem-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 20:13:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "rewiringamerica-rem"
}
JSON
