| Name | idf-geometry-plotter JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | https://github.com/dillonloh/idf-parser |
| Summary | A simple toolkit for parsing EnergyPlus IDF files and generating 2D/3D visualisations of the geometry. Based on the parseidf module by Daren Thomas. |
| upload_time | 2024-07-06 14:23:39 |
| maintainer | None |
| docs_url | None |
| author | Dillon Loh |
| requires_python | >=3.9 |
| license | The MIT License (MIT) Copyright (c) 2014 Daren Thomas, SuAT (http://suat.arch.ethz.ch) Copyright (c) 2023 Dillon Loh Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
simulation
parsing
energyplus
idf
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
ply
numpy
plotly
matplotlib
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# IDF Parser and Geometry 2D/3D Visualiser
Parses an IDF file and provides a JSON-like dictionary of lists. Refer to original README below for information on format.
Also provides functions to generate 2D Projections, 3D Point Clouds, and 3D Mesh visualisations of the
geometry in the IDF file. This is the main feature that sets it apart from the original repo.
# ORIGINAL README
# parseidf.py
Parses an IDF file (as used by EnergyPlus) into a dictionary of lists in the following manner:
- each IDF object is represented by a list of its fields, with the first field being the object type.
- each such list is appended to a list of objects with the same type in the dictionary, indexed by type:
{ A => [[A, x, y, z], [A, a, b, c]],
B => [[B, 1, 2], [B, 1, 2, 3]] }
- the index keys are all capitalized.
- also, all field values are strings, i.e. no interpretation of the values is made.
# Example
```python
import parseidf
with open(r'in.idf', 'r') as f:
idf = parseidf.parse(f.read())
print idf.keys() # lists the object types in the idf file
print idf['OUTPUT:VARIABLE'] # lists all the Output:Variable objects in the idf file
```
# Dependencies
parseidf depends on PLY (Python Lex & Yacc): https://pypi.python.org/pypi/ply/3.4
# License & Credit
This project is licensed under the terms of the MIT license. See the file "LICENSE" in the project root for more information.
This module was developed by Daren Thomas at the assistant chair for [Sustainable Architecture and Building Technologies (SuAT)](http://suat.arch.ethz.ch)
at the [Institute of Technology in Architecture](http://ita.arch.ethz.ch), ETH Zürich.
Raw data
{
"_id": null,
"home_page": "https://github.com/dillonloh/idf-parser",
"name": "idf-geometry-plotter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "simulation, parsing, energyplus, idf",
"author": "Dillon Loh",
"author_email": "Dillon Loh <loh.dillon@gmail.com>",
"download_url": null,
"platform": null,
"description": "# IDF Parser and Geometry 2D/3D Visualiser\n\nParses an IDF file and provides a JSON-like dictionary of lists. Refer to original README below for information on format.\n\nAlso provides functions to generate 2D Projections, 3D Point Clouds, and 3D Mesh visualisations of the\ngeometry in the IDF file. This is the main feature that sets it apart from the original repo.\n\n\n# ORIGINAL README\n# parseidf.py\n\nParses an IDF file (as used by EnergyPlus) into a dictionary of lists in the following manner:\n\n- each IDF object is represented by a list of its fields, with the first field being the object type.\n\n- each such list is appended to a list of objects with the same type in the dictionary, indexed by type:\n\n { A => [[A, x, y, z], [A, a, b, c]],\n B => [[B, 1, 2], [B, 1, 2, 3]] }\n\n- the index keys are all capitalized.\n\n- also, all field values are strings, i.e. no interpretation of the values is made.\n\n# Example\n\n```python\nimport parseidf\n\nwith open(r'in.idf', 'r') as f:\n idf = parseidf.parse(f.read())\nprint idf.keys() # lists the object types in the idf file\nprint idf['OUTPUT:VARIABLE'] # lists all the Output:Variable objects in the idf file\n```\n\n# Dependencies\n\nparseidf depends on PLY (Python Lex & Yacc): https://pypi.python.org/pypi/ply/3.4\n\n# License & Credit\n\nThis project is licensed under the terms of the MIT license. See the file \"LICENSE\" in the project root for more information.\n\nThis module was developed by Daren Thomas at the assistant chair for [Sustainable Architecture and Building Technologies (SuAT)](http://suat.arch.ethz.ch)\nat the [Institute of Technology in Architecture](http://ita.arch.ethz.ch), ETH Z\u00fcrich.\n\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2014 Daren Thomas, SuAT (http://suat.arch.ethz.ch) Copyright (c) 2023 Dillon Loh Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A simple toolkit for parsing EnergyPlus IDF files and generating 2D/3D visualisations of the geometry. Based on the parseidf module by Daren Thomas.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/dillonloh/idf-geometry-plotter"
},
"split_keywords": [
"simulation",
" parsing",
" energyplus",
" idf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3ee2a1c162a8df698fbf8c72995adcd44286609155887c9f1e32b728dd3d7a8",
"md5": "6e895f6502b5b17bf2b85205321b0b33",
"sha256": "49cf66917b4a0c46e0b0179fe4967e1441d73e818511240061940940130af2ed"
},
"downloads": -1,
"filename": "idf_geometry_plotter-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e895f6502b5b17bf2b85205321b0b33",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4080,
"upload_time": "2024-07-06T14:23:39",
"upload_time_iso_8601": "2024-07-06T14:23:39.502541Z",
"url": "https://files.pythonhosted.org/packages/b3/ee/2a1c162a8df698fbf8c72995adcd44286609155887c9f1e32b728dd3d7a8/idf_geometry_plotter-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-06 14:23:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dillonloh",
"github_project": "idf-parser",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "ply",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "plotly",
"specs": []
},
{
"name": "matplotlib",
"specs": []
}
],
"lcname": "idf-geometry-plotter"
}
