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 seawater RO desalination #1425

Merged
merged 37 commits into from
Jun 22, 2024

Conversation

kurbansitterley
Copy link
Contributor

Fixes/Resolves:

Seawater RO desalination flowsheet documentation for #1219

Summary/Motivation:

Add flowsheet documentation for seawater_RO_desalination.py

Changes proposed in this PR:

  • Add flowsheet doc .rst
  • Add figs for flowsheet doc

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.

@kurbansitterley
Copy link
Contributor Author

Could use unit model docs from #1408 for table 1 in this doc.

Copy link

codecov bot commented Jun 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.93%. Comparing base (6718e6a) to head (bfe1422).
Report is 37 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1425   +/-   ##
=======================================
  Coverage   93.93%   93.93%           
=======================================
  Files         310      310           
  Lines       33143    33143           
=======================================
  Hits        31133    31133           
  Misses       2010     2010           

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

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.

Some small changes and others related to making the documentation more consistent with the existing flowsheet documentation.

@ksbeattie ksbeattie added high effort/high impact 1.0 Hard requirement for the 1.0 release Priority:High High Priority Issue or PR and removed high effort/high impact labels Jun 6, 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 more minor comments

Comment on lines 18 to 41
WaterTAP costing package
* :doc:`/technical_reference/costing/watertap_costing`
Unit model costing packages
* :doc:`/technical_reference/costing/detailed_unit_model_costing`
Zero order unit and costing models
* :doc:`/technical_reference/unit_models/zero_order_unit_models/index`
Zero order costing package
* :doc:`/technical_reference/costing/zero_order_costing`
Zero order property package
* :doc:`/technical_reference/core/water_props`
Seawater property package
* :doc:`/technical_reference/property_models/seawater`
Reverse osmosis model
* :doc:`/technical_reference/unit_models/reverse_osmosis_0D`
Pressure exchanger model
* :doc:`/technical_reference/unit_models/pressure_exchanger`
IDAES Translator blocks
* :doc:`idaes:reference_guides/model_libraries/generic/unit_models/translator`
IDAES Product blocks
* :doc:`idaes:reference_guides/model_libraries/generic/unit_models/product`
IDAES Separator blocks
* :doc:`idaes:reference_guides/model_libraries/generic/unit_models/separator`
IDAES Mixer blocks
* :doc:`idaes:reference_guides/model_libraries/generic/unit_models/mixer`
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like this section is a bit intimidating to look at lol. Maybe just group some of these together like:

Costing Packages

  • WaterTAP Costing
  • ZO Costing
  • Unit Model Costing

Unit Models

  • Mixer...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah agreed and good idea

Comment on lines +230 to +236
.. note::

:sup:`1` TDS = total dissolved solids
|
:sup:`2` TSS = total suspended solids
|
:sup:`3` UV = Ultraviolet; AOP = Advanced oxidation process
Copy link
Contributor

Choose a reason for hiding this comment

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

I like how you formatted this!

kurbansitterley and others added 4 commits June 20, 2024 16:28
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
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
Contributor

@TimBartholomew TimBartholomew left a comment

Choose a reason for hiding this comment

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

I quickly skimmed, the figures are great!

@bknueven bknueven enabled auto-merge (squash) June 22, 2024 00:32
@bknueven bknueven merged commit df6264c into watertap-org:main Jun 22, 2024
24 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.

5 participants