Skip to content

Structure Documentation#62

Open
alexandrecuer wants to merge 6 commits intomainfrom
doc_reorg
Open

Structure Documentation#62
alexandrecuer wants to merge 6 commits intomainfrom
doc_reorg

Conversation

@alexandrecuer
Copy link
Copy Markdown
Contributor

No description provided.

Add documentation for equipment structure and node naming conventions in EnergyPlus API.
Copy link
Copy Markdown
Contributor Author

@alexandrecuer alexandrecuer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also simplify the README.md with a BACKGROUND.md file including all the context details, like how to install openstudio, etc, etc
cf #36

@alexandrecuer
Copy link
Copy Markdown
Contributor Author

alexandrecuer commented May 6, 2026

Or DISCLAIMER.md
No rather add a LICENSE

Updated copyright holder in the LICENSE file.
@alexandrecuer
Copy link
Copy Markdown
Contributor Author

LICENSE added

Comment thread conf/README.md
Added mandatory YAML keys to the README.
Added background information on HVAC API, IDFEditor, and eppy library, along with installation instructions for OpenStudio and EnergyPlus.
Comment thread README.md


```
py .\generate_hvac.py
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add example with --conf

Comment thread README.md
@@ -6,7 +6,7 @@ caution : current work in progress !

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add link to BACKGROUND.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant