packageConventions
Conventions
Extends from Modelica.Icons.Information (Icon for general information packages).
Information
A Modelica main package should be compliant with the UsersGuide stated in this documentation:
- Conventions of the Modelica code
- Consistent HTML documentation
- Structure to be provided by a main package
- User's Guide
- Examples containing models demonstrating the usage of the library.
- Components -- in case of a complex library a more detailed structure can be established.
- Sensors
- Sources
- Interfaces containing connectors and simple partial interface models.
- BaseClasses containing partial models with physical equations other than trivial and balance equations.
- Types containing type, enumeration and choice definitions.
- These packages should appear in the listed order.
Contents
| Name | Description |
|---|---|
| Documentation | HTML documentation |
| Terms | Terms and spelling |
| ModelicaCode | Modelica code |
| UsersGuide | User's Guide |
| Icons | Icon design |