175 add simple dymola example#177
Conversation
|
@HoeppJ as we discussed personally, I moved the function |
There was a problem hiding this comment.
Pull request overview
Adds a new “simple Dymola workflow” example and supporting utilities to make common Dymola study patterns easier to follow, while also extending variable name filtering and improving parquet export robustness.
Changes:
- Add
simple_dymola_sim_studyhelper + a new basic Dymola workflow example covering common study patterns. - Extend
get_names()with anexcludeoption and add tests for the new behavior. - Improve parquet saving for SparseDtype columns and add deprecation warnings for Dymola structural-parameter APIs.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
ebcpy/simulationapi/dymola_utils.py |
New reusable helper for common Dymola simulation study workflows. |
examples/e3_0_simple_dymola_example.py |
New minimal, recommended Dymola workflow example using modifiers + postprocessing. |
ebcpy/utils/__init__.py |
Adds exclude filtering to get_names(). |
tests/test_utils.py |
Adds test coverage for get_names(..., exclude=...). |
ebcpy/simulationapi/dymola_api.py |
Adds deprecation warnings for structural_parameters and modify_structural_parameters. |
tests/test_simulationapi.py |
Adds validation tests and minimal integration tests for simple_dymola_sim_study. |
ebcpy/data_types.py |
Densifies SparseDtype columns before parquet write. |
examples/README.md |
Updates example instructions and documents the new example. |
examples/e5_modifier_example.py |
Updates stated learning goals to emphasize structural modifiers/redeclare. |
ebcpy/__init__.py |
Exposes simple_dymola_sim_study at package top-level; bumps version. |
CHANGELOG.md |
Adds v0.8.0 changelog entries for the new utilities and changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/RWTH-EBC/ebcpy/sessions/c1a15a25-9907-4951-8cff-7131a327d25d Co-authored-by: HvanderStok <101417334+HvanderStok@users.noreply.github.com>
…_sim_study" This reverts commit ae3e02c.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
|
||
| if __name__ == "__main__": | ||
| # TODO: Adjust this path to your local BESMod startup script | ||
| MOS_SCRIPT = r"D:\01_git\BESMod\startup.mos" |
There was a problem hiding this comment.
Would suggest to rename this to mos_script_startup to make clear that this refers to the startup script.
Or mos_scirpt_pre as in simple_dymola_sim_study()
| return df_path | ||
|
|
||
|
|
||
| if __name__ == "__main__": |
There was a problem hiding this comment.
Would suggest to keep the example structure consistent with other examples.
So maybe rename to function main() and call main over "if name == 'main':"
Add basic Dymola simulation workflow example
Closes #175
Adds a new example demonstrating a recommended workflow for Dymola simulation studies (`e3_0_simple_dymola_example). The example covers four common patterns:
The example also demonstrates:
The
simple_dymola_sim_studyfunction is designed as a reusable template that users can adapt to their own studies.Additionally, I improved a little bit the saving of parquet files and added a deprecation warning for the
structural_parameterskeyword of theDymolaAPI(see #176)