-
Notifications
You must be signed in to change notification settings - Fork 62
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
Conversation
Could use unit model docs from #1408 for table 1 in this doc. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
There was a problem hiding this 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.
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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
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` |
There was a problem hiding this comment.
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...
There was a problem hiding this comment.
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
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
docs/technical_reference/flowsheets/seawater_RO_desalination.rst
Outdated
Show resolved
Hide resolved
.. note:: | ||
|
||
:sup:`1` TDS = total dissolved solids | ||
| | ||
:sup:`2` TSS = total suspended solids | ||
| | ||
:sup:`3` UV = Ultraviolet; AOP = Advanced oxidation process |
There was a problem hiding this comment.
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!
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this 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!
Fixes/Resolves:
Seawater RO desalination flowsheet documentation for #1219
Summary/Motivation:
Add flowsheet documentation for
seawater_RO_desalination.py
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: