electrificationutils 0.3.1

A collection of models providing insights on different components of household electrification.

dml-small-models

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.3.1
• Generator version: 7.10.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import electrificationutils

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import electrificationutils

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import electrificationutils
from electrificationutils.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = electrificationutils.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with electrificationutils.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = electrificationutils.GGRFHVACUpdateApi(api_client)
    electric_efficiency = electrificationutils.HvacEfficiencyElectricDetailed() # HvacEfficiencyElectricDetailed | 

    try:
        # Ggrf Hvac Upgrade Btu Per Watt Hour
        api_response = api_instance.ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get(electric_efficiency)
        print("The response of GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
GGRFHVACUpdateApi	ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get	GET /ggrf/hvac_upgrade/btu_per_watt_hour/v1/	Ggrf Hvac Upgrade Btu Per Watt Hour
GGRFHVACUpdateApi	ggrf_hvac_upgrade_electric_to_electric_ggrf_hvac_upgrade_electric_to_electric_v1_get	GET /ggrf/hvac_upgrade/electric-to-electric/v1/	Ggrf Hvac Upgrade Electric To Electric
GGRFHVACUpdateApi	ggrf_hvac_upgrade_fossil_to_electric_ggrf_hvac_upgrade_fossil_to_electric_v1_get	GET /ggrf/hvac_upgrade/fossil-to-electric/v1/	Ggrf Hvac Upgrade Fossil To Electric
HealthDataApi	query_metrics_health_data_query_v1_get	GET /health_data_query/v1/	Query Metrics
RangeUpgradeApi	range_upgrade_range_upgrade_v1_get	GET /range_upgrade/v1/	Range Upgrade

Documentation For Models

• EnergyQuantity
• EnergyTradeoff
• GroupBy
• HTTPValidationError
• HvacEfficiencyElectricDetailed
• HvacEfficiencyFossilFuels
• HvacUpdateResults
• Metrics
• RangeFuelType
• UpgradeOption
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Endpoints do not require authorization.

Author