# EnergyPlus API Helper Scripts
This project is a small library of helper functionality and, more importantly, demo scripts, for interacting with the EnergyPlus API.
The EnergyPlus Python API is not on PyPi (as of now), it simply comes with the EnergyPlus installation.
This library makes that process a bit easier, and also offers a set of demos in the `energyplus_api_helpers/demos` folder.
A super minimal example using the helper class here:
```python
from pathlib import Path
from energyplus_api_helpers.import_helper import EPlusAPIHelper
helper = EPlusAPIHelper(Path('/path/to/EnergyPlus-22-2-0'))
api = helper.get_api_instance()
state = api.state_manager.new_state()
return_value = api.runtime.run_energyplus(state, ['-D', helper.path_to_test_file('5ZoneAirCooled.idf')])
```
In this example, the helper class is constructed simply by pointing it to a valid EnergyPlus install path (or build/Products directory for developers).
The helper class is then used to get an EnergyPlus API instance, which is in turn used to create a new EnergyPlus "state".
Finally, EnergyPlus is executed with some basic command line arguments passed into the `run_energyplus` function of the main EnergyPlus API.
## Code Quality
[](https://github.com/Myoldmopar/EnergyPlusAPIDemos/actions/workflows/flake8.yml)
Code is checked for style using GitHub Actions.
## Releases
[](https://github.com/Myoldmopar/EnergyPlusAPIDemos/actions/workflows/release.yml)
When a release is tagged, a GitHub Action workflow will create a Python wheel and upload it to the PyPi server.
To install into an existing Python environment, execute `pip install energyplus_api_helpers`
Raw data
{
"_id": null,
"home_page": "https://github.com/Myoldmopar/EnergyPlusAPIHelper",
"name": "energyplus-api-helpers",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "energyplus_launch,ep_launch,EnergyPlus,eplus,Energy+,Building Simulation,Whole Building Energy Simulation,Heat Transfer,HVAC,Modeling",
"author": "Edwin Lee, for NREL, for the United States Department of Energy",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3f/74/cf1ecad471601a01c0dc996f7edd174fcf4340fe6da3066c3435ab669d3a/energyplus_api_helpers-0.4.tar.gz",
"platform": "Linux (Tested on Ubuntu)",
"description": "# EnergyPlus API Helper Scripts\n\nThis project is a small library of helper functionality and, more importantly, demo scripts, for interacting with the EnergyPlus API.\nThe EnergyPlus Python API is not on PyPi (as of now), it simply comes with the EnergyPlus installation.\nThis library makes that process a bit easier, and also offers a set of demos in the `energyplus_api_helpers/demos` folder.\n\nA super minimal example using the helper class here:\n\n```python\nfrom pathlib import Path\nfrom energyplus_api_helpers.import_helper import EPlusAPIHelper\n\nhelper = EPlusAPIHelper(Path('/path/to/EnergyPlus-22-2-0'))\napi = helper.get_api_instance()\nstate = api.state_manager.new_state()\nreturn_value = api.runtime.run_energyplus(state, ['-D', helper.path_to_test_file('5ZoneAirCooled.idf')])\n```\n\nIn this example, the helper class is constructed simply by pointing it to a valid EnergyPlus install path (or build/Products directory for developers).\nThe helper class is then used to get an EnergyPlus API instance, which is in turn used to create a new EnergyPlus \"state\".\nFinally, EnergyPlus is executed with some basic command line arguments passed into the `run_energyplus` function of the main EnergyPlus API.\n\n## Code Quality\n\n[](https://github.com/Myoldmopar/EnergyPlusAPIDemos/actions/workflows/flake8.yml)\n\nCode is checked for style using GitHub Actions.\n\n## Releases\n\n[](https://github.com/Myoldmopar/EnergyPlusAPIDemos/actions/workflows/release.yml)\n\nWhen a release is tagged, a GitHub Action workflow will create a Python wheel and upload it to the PyPi server.\n\nTo install into an existing Python environment, execute `pip install energyplus_api_helpers`\n\n\n",
"bugtrack_url": null,
"license": "ModifiedBSD",
"summary": "A set of helper classes, functions and demos, for interacting with the EnergyPlus Python API",
"version": "0.4",
"split_keywords": [
"energyplus_launch",
"ep_launch",
"energyplus",
"eplus",
"energy+",
"building simulation",
"whole building energy simulation",
"heat transfer",
"hvac",
"modeling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2546ca6f8a377d0f80c66c3354489d59b1ee0360d1d887d50de0d2b6362c9f53",
"md5": "b9e302f474aedc658531bc51de52b88e",
"sha256": "60c24c2e68ca0e513ca01770cc8671279458c6dda46cd18b919b16466b943642"
},
"downloads": -1,
"filename": "energyplus_api_helpers-0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9e302f474aedc658531bc51de52b88e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18120,
"upload_time": "2023-04-14T15:22:48",
"upload_time_iso_8601": "2023-04-14T15:22:48.902959Z",
"url": "https://files.pythonhosted.org/packages/25/46/ca6f8a377d0f80c66c3354489d59b1ee0360d1d887d50de0d2b6362c9f53/energyplus_api_helpers-0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f74cf1ecad471601a01c0dc996f7edd174fcf4340fe6da3066c3435ab669d3a",
"md5": "9854d2712f57e5850985beb7f27a49de",
"sha256": "f5ee3c47b12d268f3fe55827abab691eadf1e4ec0000d3dd1ae2a1a0ea16f1aa"
},
"downloads": -1,
"filename": "energyplus_api_helpers-0.4.tar.gz",
"has_sig": false,
"md5_digest": "9854d2712f57e5850985beb7f27a49de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9458,
"upload_time": "2023-04-14T15:22:49",
"upload_time_iso_8601": "2023-04-14T15:22:49.941820Z",
"url": "https://files.pythonhosted.org/packages/3f/74/cf1ecad471601a01c0dc996f7edd174fcf4340fe6da3066c3435ab669d3a/energyplus_api_helpers-0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-14 15:22:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Myoldmopar",
"github_project": "EnergyPlusAPIHelper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "energyplus-api-helpers"
}
JSON
