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

add documentation for MD flowsheet #1444

Merged
merged 18 commits into from
Jun 28, 2024

Conversation

ElmiraShamlou
Copy link
Contributor

@ElmiraShamlou ElmiraShamlou commented Jun 20, 2024

addresses #1219 for MD

(replace this with the issue # fixed or resolved, if no issue exists then a brief statement of what this PR does)

Summary/Motivation:

Changes proposed in this PR:

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.

@ElmiraShamlou ElmiraShamlou self-assigned this Jun 20, 2024
@ElmiraShamlou ElmiraShamlou added the Priority:High High Priority Issue or PR label Jun 20, 2024
Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.94%. Comparing base (b1a84b4) to head (f6b2e6b).
Report is 29 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1444   +/-   ##
=======================================
  Coverage   93.94%   93.94%           
=======================================
  Files         310      310           
  Lines       33206    33206           
=======================================
  Hits        31194    31194           
  Misses       2012     2012           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ksbeattie ksbeattie added the 1.0 Hard requirement for the 1.0 release label Jun 20, 2024
Copy link
Contributor

@MarcusHolly MarcusHolly left a comment

Choose a reason for hiding this comment

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

Other than one last typo, LGTM

Copy link
Contributor

@kurbansitterley kurbansitterley left a comment

Choose a reason for hiding this comment

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

Mostly formatting changes in a table, I made suggestions where possible.

Only one clarifying question at the end.

"**Pumps**"
"Efficiency", "0.8", "dimensionless"
"**Heater**"
"Maximum outlet temperature", "90", "°C"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"Maximum outlet temperature", "90", "°C"
"Maximum outlet temperature", "363", ":math:`\text{K}`"

@kurbansitterley
Copy link
Contributor

oops didn't realize Adam approved while I was reviewing.

ElmiraShamlou and others added 7 commits June 27, 2024 17:01
Co-authored-by: Kurban Sitterley <kurban.sitterley@nrel.gov>
Co-authored-by: Kurban Sitterley <kurban.sitterley@nrel.gov>
Co-authored-by: Kurban Sitterley <kurban.sitterley@nrel.gov>
Co-authored-by: Kurban Sitterley <kurban.sitterley@nrel.gov>
Co-authored-by: Kurban Sitterley <kurban.sitterley@nrel.gov>
Copy link
Contributor

@kurbansitterley kurbansitterley left a comment

Choose a reason for hiding this comment

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

LGTM

@lbianchi-lbl lbianchi-lbl merged commit c627b20 into watertap-org:main Jun 28, 2024
25 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0 Hard requirement for the 1.0 release Priority:High High Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants