Add documentation for electroNP, OARO and UV-AOP #1377
Conversation
| "Reactor sizing cost", ":math:`C_V`", "sizing_cost", "1000", ":math:`\text{$/m^3}`" | ||
| "Magnesium chloride cost", ":math:`C_{MgCl2}`", "magnesium_chloride_cost", "0.0786", ":math:`\text{$/kg}`" | ||
| "Phosphorus recovery value*", ":math:`C_{RP}`", "phosphorus_recovery_value", "-0.07", ":math:`\text{$/kg}`" |
There was a problem hiding this comment.
Units not displaying correctly
There was a problem hiding this comment.
Also, we should decide on whether we want to just display $ or USD_YYYY as the units for cost. I've done the latter in my documentation so far, but whatever we decide to do, we should be consistent.
|
|
||
| "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" | ||
| "Inlet volumetric flow rate", ":math:`Q_{in}`", "mixed_state[0].flow_vol", ":math:`\text{m^3/hr}`" |
| "Membrane replacement factor", ":math:`f`", "factor_membrane_replacement", "0.15", ":math:`\text{dimensionless}`" | ||
| "Membrane cost", ":math:`C_A`", "membrane_cost", "30", ":math:`\text{$/m^2}`" | ||
| "High pressure membrane cost", ":math:`C_hA`", "high_pressure_membrane_cost", "50", ":math:`\text{$/m^2}`" |
There was a problem hiding this comment.
Units not displaying correctly
|
|
||
| "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" | ||
| "Membrane area", ":math:`A`", "area", ":math:`\text{m^2}`" |
| "UV reactor cost", ":math:`C_F`", "reactor_cost", "202.346", ":math:`\text{$/(m^3/hr)}`" | ||
| "UV lamps, sleeves, ballasts and sensors cost", ":math:`C_l`", "lamp_cost", "235.5", ":math:`\text{$/kW}`" |
There was a problem hiding this comment.
Units not displaying correctly
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1377 +/- ##
=======================================
Coverage 93.92% 93.92%
=======================================
Files 335 335
Lines 35620 35620
=======================================
Hits 33456 33456
Misses 2164 2164 ☔ View full report in Codecov by Sentry. |
Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com>
|
|
||
| .. csv-table:: | ||
| :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" | ||
| :header: "Description", "Symbol", "Variable Name", "Units" |
There was a problem hiding this comment.
Based on feedback from yesterday, there should be a column for Index here instead of Default Value.
| :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" | ||
| :header: "Description", "Symbol", "Variable Name", "Units" |
There was a problem hiding this comment.
Based on feedback from yesterday, there should be a column for Index here instead of Default Value.
Fixes/Resolves:
issue #1360
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: