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

Flowsheet documentation for NaCl crystallizer #1403

Merged
merged 5 commits into from
May 22, 2024
Merged

Conversation

OOAmusat
Copy link
Contributor

Fixes/Resolves:

NaCl crystallizer flowsheet documentation for #1219

Summary/Motivation:

Adding NaCl crystallizer flowsheet documentation

Changes proposed in this PR:

  • Only includes adding .rst for the NaCl crystallizer example

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.

@OOAmusat OOAmusat self-assigned this May 21, 2024
@OOAmusat OOAmusat added Priority:High High Priority Issue or PR 1.0 Hard requirement for the 1.0 release labels May 21, 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.

A few minor comments to address

docs/technical_reference/flowsheets/crystallization.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/crystallization.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/crystallization.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/crystallization.rst Outdated Show resolved Hide resolved
docs/technical_reference/flowsheets/crystallization.rst Outdated Show resolved Hide resolved
@OOAmusat OOAmusat requested a review from MarcusHolly May 21, 2024 22:17
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.

LGTM

Copy link

codecov bot commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.02%. Comparing base (3cf1fb8) to head (0ab70ad).
Report is 57 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1403   +/-   ##
=======================================
  Coverage   94.02%   94.02%           
=======================================
  Files         335      335           
  Lines       35620    35620           
=======================================
  Hits        33491    33491           
  Misses       2129     2129           

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

Comment on lines +27 to +28
Documentation for the crystallizer unit model can be found below.
* `Crystallizer <https://watertap.readthedocs.io/en/latest/technical_reference/unit_models/crystallizer_0D.html>`_
Copy link
Contributor

Choose a reason for hiding this comment

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

One more thing I missed in my review - you should also provide a link here to the crystallization property package. Although it looks like there's no documentation for this yet... I think it'd be nice to have this for the 1.0 release, so maybe it's best to address this in a separate PR that also adds the prop pack documentation.

@bknueven bknueven merged commit 163a7d2 into main May 22, 2024
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.

4 participants