IDAES / examples-pse

(ARCHIVED - use IDAES/examples) Example Python code, Jupyter Notebooks, and other files for the IDAES PSE
https://idaes.github.io/examples-pse/
Other
20 stars 36 forks source link

Update property metadata #173

Closed andrewlee94 closed 1 year ago

andrewlee94 commented 1 year ago

https://github.com/IDAES/idaes-pse/pull/995 changes how metadata is defined for property packages, and enforces standard naming conventions (or at least forces users to explicitly declare non-standard names). This revealed that some of our examples were using non-standard names, which this PR addresses.

This PR will likely fail without the changes in idaes-pse, but this will be necessary to test those changes.

Proposed changes:

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.
andrewlee94 commented 1 year ago

@bpaul4 I addressed the issues you found, and the test failures we are seeing as expected (due to the yet-to-be-merged changes in idaes-pse).

However, this PR needs to be merged before the changes in idaes-pse (despite the test failures). We have a chicken-and-egg problem where we have test failures on both sides due to these changes, so one side needs to be merged first with failures, and I think it is best to start here.

bpaul4 commented 1 year ago

FYI it's also possible to fix this PR's head to the corresponding idaes-pse PR branch, rather than merging to test it, if that would be more convenient.

andrewlee94 commented 1 year ago

@bpaul4 That won't really work - the issue is that neither PR will pass tests until one of them has been merged, so we just have to merge one with failures. Even if we did change the head to test this PR, we would still have to undo the changes before we merge it in which case the failures would be back (and it takes over an hour to run the tests too).