Metadata-Version: 2.1
Name: rewiringamerica_rem
Version: 0.3.0
Summary: Residential Electrification Model API
Home-page: https://github.com/GIT_USER_ID/GIT_REPO_ID
License: Apache 2.0
Keywords: OpenAPI,OpenAPI-Generator,Residential Electrification Model API
Author: Rewiring America
Author-email: datascience@rewiringamerica.org
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: keyrings-google-artifactregistry-auth (>=1.1.2,<2.0.0)
Requires-Dist: pydantic (>=2)
Requires-Dist: python-dateutil (>=2.8.2)
Requires-Dist: typing-extensions (>=4.7.1)
Requires-Dist: urllib3 (>=1.25.3,<3.0.0)
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Description-Content-Type: text/markdown

# 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



