search

Volue-Public / energy-mesh-python

A Python API able to communicate with Volue Energy's Mesh server.
Other
10 stars 0 forks source link

Use `CaseGroup/CaseName` to refer to hydsim cases #399

Closed erny-powel closed 7 months ago

erny-powel commented 7 months ago

CaseGroup/CaseName is established syntax used in various UIs, Optimal Gateway, and Automation Framework. As discussed in https://github.com/Volue/energy-sim/issues/742#issuecomment-1811942095.

There's an argument for more user friendly error handling here, but I think this is API compatible with a future improvement, and I want to get this API break done ASAP. For now you'll get a ValueError if the split doesn't split.

Closes https://github.com/Volue-Public/energy-mesh-python/issues/398.

erny-powel commented 7 months ago

FYI @voluetore, this is an API break for simulations.

erny-powel commented 7 months ago

Tests will be added in another PR? Is there a separate issue for tests?

See https://github.com/Volue/energy-test-framework/issues/276 and https://github.com/Volue/energy-test-framework/pull/277 courtesy of @voluetore. As discussed I'll create an internal issue for future discussion.