{"id":27180158,"url":"https://github.com/jmarrec/openstudio_to_energyplusapi","last_synced_at":"2025-04-09T14:25:45.290Z","repository":{"id":43671317,"uuid":"327009916","full_name":"jmarrec/OpenStudio_to_EnergyPlusAPI","owner":"jmarrec","description":"Python: using OpenStudio Bindings, EnergyPlus API, and matplotlib","archived":false,"fork":false,"pushed_at":"2024-03-19T01:04:08.000Z","size":3926,"stargazers_count":47,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-06-11T16:07:31.710Z","etag":null,"topics":["energyplus","jupyter","matplotlib","openstudio","openstudio-sdk","python"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jmarrec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-05T13:38:58.000Z","updated_at":"2024-05-17T08:13:04.000Z","dependencies_parsed_at":"2022-09-01T13:40:40.902Z","dependency_job_id":null,"html_url":"https://github.com/jmarrec/OpenStudio_to_EnergyPlusAPI","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmarrec%2FOpenStudio_to_EnergyPlusAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmarrec%2FOpenStudio_to_EnergyPlusAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmarrec%2FOpenStudio_to_EnergyPlusAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmarrec%2FOpenStudio_to_EnergyPlusAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmarrec","download_url":"https://codeload.github.com/jmarrec/OpenStudio_to_EnergyPlusAPI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054530,"owners_count":21040020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["energyplus","jupyter","matplotlib","openstudio","openstudio-sdk","python"],"created_at":"2025-04-09T14:25:44.797Z","updated_at":"2025-04-09T14:25:45.282Z","avatar_url":"https://github.com/jmarrec.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python: using OpenStudio Bindings, EnergyPlus API, and matplotlib\n\nWritten By Julien Marrec of [EffiBEM](https://www.effibem.com), circa 2021-01-05.\n\n## Purpose\n\nThis notebook aims to demonstrate the use of:\n\n* **The OpenStudio Python Bindings**.\n    * This is used to efficiently create and customize a model to be simulated\n\n    * **Note**: Until a version \u003e 3.1.0 (eg 3.1.1 or 3.2.0) is out on [**pypi**](https://pypi.org/project/openstudio/), I recommend using the [**testpypi**](https://test.pypi.org/project/openstudio/) version where I made usability adjustments. You can do `pip install -i https://test.pypi.org/simple/ openstudio` for that one.\n\n\n* **The EnergyPlus Python API**, and how to use callbacks to retrieve data\n\n* **Updating a live matplotlib plot during E+ simulation** via the EnergyPlus Python API callback.\n\n\nSeveral options and examples are shown below. **I strongly recommend you encapsulate your data inside a class** (see section 3.4) instead of relying on python `global` data, but it does bring a sligthly higher complexity level so for simple stuff you can ommit that and use 3.1 to 3.3 instead (which are also used as an entry point to demonstrate the API)\n\n----\n\n**Resources:**\n\n* OpenStudio SDK documentation: https://openstudio-sdk-documentation.s3.amazonaws.com/index.html\n* EnergyPlus Python API documentation: https://energyplus.readthedocs.io/en/latest/api.html\n\n## Demo\n\n![](images/interactive_plot.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmarrec%2Fopenstudio_to_energyplusapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmarrec%2Fopenstudio_to_energyplusapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmarrec%2Fopenstudio_to_energyplusapi/lists"}