Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update naming conventions #1436

Open
larissakuehn opened this issue Jun 5, 2023 · 2 comments
Open

Update naming conventions #1436

larissakuehn opened this issue Jun 5, 2023 · 2 comments
Assignees

Comments

@larissakuehn
Copy link
Contributor

larissakuehn commented Jun 5, 2023

Naming conventions are not very clear, so they should be updated and sorted more clearly:
https://github.com/RWTH-EBC/AixLib/wiki/Variable-Naming

First steps:

  • Check current version of Buildings naming convention and update column
  • Clear the table and only keep the following columns: meaning, aixlib, buildings, SI units (update to modelica 4.0), modelica type
@arnoldfuetterer
Copy link
Contributor

Table does not exist in this version at IBPSA or Buildings anymore. Both libraries know use the naming conventions that are described in the Buildings.UsesGuide (https://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_UsersGuide.html#Buildings.UsersGuide.Conventions)

Progress:

Comments:

  • Some variable names are not specified as exceptions for three character naming conventions but in Buildings.UsersGuide.Conventions
  • We have to decide how we will deal with those. For now they will appear in the table. For exampe: A for Area

Work in Progress:

  • update of variable names in current table

@arnoldfuetterer
Copy link
Contributor

Progress:

  • Namespaces page is updated. It only contains deviations and added details to the Buildings.UsersGuide conventions.
  • Variable names page is deleted since it became obsolete
  • Table is now used to show Existing namings vs Desired namings (exceptions form naming convention) in the AixLib library

Comments:

  • table shall be completed in the long term (maybe by a python script)

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

No branches or pull requests

3 participants