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

Revision of OLI Cloud Flash Calculations #1237

Merged
merged 74 commits into from
Feb 2, 2024
Merged

Revision of OLI Cloud Flash Calculations #1237

merged 74 commits into from
Feb 2, 2024

Conversation

veccp
Copy link
Contributor

@veccp veccp commented Dec 5, 2023

Fixes/Resolves:

Provides a framework for adding additional OLI Cloud flash calculations as the need emerges. Currently supporting Water Analysis and Isothermal Analysis.

Summary/Motivation:

Prior analyses used bespoke scripts to make flash calculations and extract data; this approach simplifies the process for the user

Changes proposed in this PR:

  • Standardized setup for flash calculation calls
  • Extracting output data is simplified
  • Added flexibility to parametric sweeps/surveys

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.


:return boolean: True on success, False on failure
:return status: bool indicating success or failure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should "refresh" be in the doc string (even though it is self-explanatory)?

Copy link
Contributor Author

@veccp veccp Jan 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I just missed it

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@veccp Can you add it? This PR is pretty much ready to go but this is a super minor revision that should be handled in this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I just pushed the change

@lbianchi-lbl
Copy link
Contributor

lbianchi-lbl commented Jan 18, 2024

The low reported patch coverage is expected: see #1249 for details.

Copy link
Contributor

@adam-a-a adam-a-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - I think the only outstanding comment was a minor docstring issue, and even though I asked @veccp to add it in this PR, I don't mind just leaving it for a subsequent PR so that we don't have to wait for all tests to rerun in this PR.

@adam-a-a
Copy link
Contributor

LGTM - I think the only outstanding comment was a minor docstring issue, and even though I asked @veccp to add it in this PR, I don't mind just leaving it for a subsequent PR so that we don't have to wait for all tests to rerun in this PR.

Oh- we'll have to wait for tests to rerun anyway since we have to merge main. I'll leave it open.

Copy link
Contributor

@OOAmusat OOAmusat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@adam-a-a adam-a-a enabled auto-merge (squash) February 1, 2024 21:20
@bknueven bknueven disabled auto-merge February 1, 2024 22:23
@bknueven
Copy link
Contributor

bknueven commented Feb 1, 2024

@adam-a-a I was waiting for us to test this against OLI before merging.

Copy link
Contributor

@bknueven bknueven left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we can run the tests and they pass, I am happy.

@bknueven bknueven enabled auto-merge (squash) February 1, 2024 23:19
@bknueven bknueven merged commit ab11c2d into watertap-org:main Feb 2, 2024
23 checks passed
@veccp veccp deleted the flash_calcs branch February 2, 2024 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chem team Issues directly related to the chem team oli Priority:High High Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants