# 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](https://openapi-generator.tech) 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:
```sh
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:
```python
import electrificationutils
```
### 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 electrificationutils
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/GGRFHVACUpdateApi.md#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**](docs/GGRFHVACUpdateApi.md#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**](docs/GGRFHVACUpdateApi.md#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**](docs/HealthDataApi.md#query_metrics_health_data_query_v1_get) | **GET** /health_data_query/v1/ | Query Metrics
*RangeUpgradeApi* | [**range_upgrade_range_upgrade_v1_get**](docs/RangeUpgradeApi.md#range_upgrade_range_upgrade_v1_get) | **GET** /range_upgrade/v1/ | Range Upgrade
## Documentation For Models
- [EnergyQuantity](docs/EnergyQuantity.md)
- [EnergyTradeoff](docs/EnergyTradeoff.md)
- [GroupBy](docs/GroupBy.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [HvacEfficiencyElectricDetailed](docs/HvacEfficiencyElectricDetailed.md)
- [HvacEfficiencyFossilFuels](docs/HvacEfficiencyFossilFuels.md)
- [HvacUpdateResults](docs/HvacUpdateResults.md)
- [Metrics](docs/Metrics.md)
- [RangeFuelType](docs/RangeFuelType.md)
- [UpgradeOption](docs/UpgradeOption.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/rewiringamerica/dml-small-models",
"name": "electrificationutils",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, electrification, air quality, health, induction, climate",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/de/69/e55817c52718f5b113dd4025ddef90d786a80b8e43d8850daf260b67e866/electrificationutils-0.3.1.tar.gz",
"platform": null,
"description": "# dml-small-models\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\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.1\n- Generator version: 7.10.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport electrificationutils\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 electrificationutils\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 electrificationutils\nfrom electrificationutils.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = electrificationutils.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith electrificationutils.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = electrificationutils.GGRFHVACUpdateApi(api_client)\n electric_efficiency = electrificationutils.HvacEfficiencyElectricDetailed() # HvacEfficiencyElectricDetailed | \n\n try:\n # Ggrf Hvac Upgrade Btu Per Watt Hour\n api_response = api_instance.ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get(electric_efficiency)\n print(\"The response of GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_btu_per_watt_hour_ggrf_hvac_upgrade_btu_per_watt_hour_v1_get**](docs/GGRFHVACUpdateApi.md#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\n*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_electric_to_electric_ggrf_hvac_upgrade_electric_to_electric_v1_get**](docs/GGRFHVACUpdateApi.md#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\n*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_fossil_to_electric_ggrf_hvac_upgrade_fossil_to_electric_v1_get**](docs/GGRFHVACUpdateApi.md#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\n*HealthDataApi* | [**query_metrics_health_data_query_v1_get**](docs/HealthDataApi.md#query_metrics_health_data_query_v1_get) | **GET** /health_data_query/v1/ | Query Metrics\n*RangeUpgradeApi* | [**range_upgrade_range_upgrade_v1_get**](docs/RangeUpgradeApi.md#range_upgrade_range_upgrade_v1_get) | **GET** /range_upgrade/v1/ | Range Upgrade\n\n\n## Documentation For Models\n\n - [EnergyQuantity](docs/EnergyQuantity.md)\n - [EnergyTradeoff](docs/EnergyTradeoff.md)\n - [GroupBy](docs/GroupBy.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [HvacEfficiencyElectricDetailed](docs/HvacEfficiencyElectricDetailed.md)\n - [HvacEfficiencyFossilFuels](docs/HvacEfficiencyFossilFuels.md)\n - [HvacUpdateResults](docs/HvacUpdateResults.md)\n - [Metrics](docs/Metrics.md)\n - [RangeFuelType](docs/RangeFuelType.md)\n - [UpgradeOption](docs/UpgradeOption.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\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "LICENSE.md",
"summary": "A collection of models providing insights on different components of household electrification.",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/rewiringamerica/dml-small-models",
"Repository": "https://github.com/rewiringamerica/dml-small-models"
},
"split_keywords": [
"openapi",
" openapi-generator",
" electrification",
" air quality",
" health",
" induction",
" climate"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cea667d14c377a60c134eeb4252df744fe175a06ea8ca059aa354231a663b326",
"md5": "922f964377a890fd6a58029a1d77bd13",
"sha256": "58fa5e7779f0299b86dee74eb1a7fe1aacf9f464a92c1863296ca30b09a986d2"
},
"downloads": -1,
"filename": "electrificationutils-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "922f964377a890fd6a58029a1d77bd13",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 47815,
"upload_time": "2024-12-02T20:52:20",
"upload_time_iso_8601": "2024-12-02T20:52:20.147579Z",
"url": "https://files.pythonhosted.org/packages/ce/a6/67d14c377a60c134eeb4252df744fe175a06ea8ca059aa354231a663b326/electrificationutils-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de69e55817c52718f5b113dd4025ddef90d786a80b8e43d8850daf260b67e866",
"md5": "31b9b2c1b12ecc2864356f4a15b4e1b9",
"sha256": "ca95a2ce7e0b770e5edc74f8bd69149678318a2877e0a2048ff4145351134dca"
},
"downloads": -1,
"filename": "electrificationutils-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "31b9b2c1b12ecc2864356f4a15b4e1b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 32658,
"upload_time": "2024-12-02T20:52:21",
"upload_time_iso_8601": "2024-12-02T20:52:21.471621Z",
"url": "https://files.pythonhosted.org/packages/de/69/e55817c52718f5b113dd4025ddef90d786a80b8e43d8850daf260b67e866/electrificationutils-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 20:52:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rewiringamerica",
"github_project": "dml-small-models",
"github_not_found": true,
"lcname": "electrificationutils"
}
JSON
