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.

Sign up for GitHub

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

Jump to bottom

Update Costing Doc Automation #1394

Merged
merged 11 commits into from
May 22, 2024
Merged

Update Costing Doc Automation #1394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
53cf83a
Change Default Value column to Index
MarcusHolly May 20, 2024
6eca779
Merge branch 'main' into costing_automation_update
MarcusHolly May 20, 2024
8a3a310
Address merge conflicts
MarcusHolly May 21, 2024
0422eb2
Change variable and parameter names to monospacing font in templates
MarcusHolly May 21, 2024
3b12714
Merge branch 'costing_automation_update' of https://github.com/Marcus…
MarcusHolly May 21, 2024
a68a6b2
Update existing documentation with monospacing font
MarcusHolly May 21, 2024
218e11f
Correct typo
MarcusHolly May 21, 2024
2e99b05
Merge branch 'main' into costing_automation_update
MarcusHolly May 21, 2024
f6ef3f0
Update crystalllizer documentation with monospacing font
MarcusHolly May 21, 2024
3739c1e
Address merge conflicts
MarcusHolly May 22, 2024
c527812
Add monospacing font to electrolyzer costing doc
MarcusHolly May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/technical_reference/costing/aeration_tank.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
.. csv-table::
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"Capital cost A parameter :math:`^1`", ":math:`A`", "capital_a_parameter", "1.1141e3", ":math:`\text{USD}_{1997}`"
"Capital cost B parameter :math:`^1`", ":math:`B`", "capital_b_parameter", "0.6", ":math:`\text{dimensionless}`"
"Capital cost A parameter :math:`^1`", ":math:`A`", "``capital_a_parameter``", "1.1141e3", ":math:`\text{USD}_{1997}`"
"Capital cost B parameter :math:`^1`", ":math:`B`", "``capital_b_parameter``", "0.6", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++
Expand Down
8 changes: 4 additions & 4 deletions docs/technical_reference/costing/anaerobic_digester.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
.. csv-table::
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`"
"description", ":math:`Symbol_{example}`", "``parameter_name``", "1", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++

The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``:

.. csv-table::
:header: "Description", "Symbol", "Variable Name", "Default Value", "Units"
:header: "Description", "Symbol", "Variable Name", "Index", "Units"

"description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`"
"description", ":math:`Symbol_{example}`", "``variable_name``", "[t]", ":math:`\text{dimensionless}`"

Capital Cost Calculations
+++++++++++++++++++++++++
Expand All @@ -34,7 +34,7 @@ Describe capital costs..keep it concise where possible

C_{cap,example1} = fill in equation for each component in total capex equation


Operating Cost Calculations
+++++++++++++++++++++++++++

Expand Down
6 changes: 3 additions & 3 deletions docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
' :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"\n\n'
)
f.write(
' "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\\text{dimensionless}`"\n'
' "description", ":math:`Symbol_{example}`", "``parameter_name``", "1", ":math:`\\text{dimensionless}`"\n'
)

# TODO: add var tables
Expand All @@ -140,10 +140,10 @@
)
f.write(".. csv-table::\n")
f.write(
' :header: "Description", "Symbol", "Variable Name", "Default Value", "Units"\n\n'
' :header: "Description", "Symbol", "Variable Name", "Index", "Units"\n\n'
)
f.write(
' "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\\text{dimensionless}`"\n'
' "description", ":math:`Symbol_{example}`", "``variable_name``", "[t]", ":math:`\\text{dimensionless}`"\n'
)

# TODO: add capex eqs
Expand Down
22 changes: 11 additions & 11 deletions docs/technical_reference/costing/clarifier.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"**Circular clarifier**"
"Capital cost A parameter :math:`^1`", ":math:`A_{circular}`", "construction_a_parameter", "-6e-4", ":math:`\text{USD}_{2011}\text{/ft}^4`"
"Capital cost B parameter :math:`^1`", ":math:`B_{circular}`", "construction_b_parameter", "98.952", ":math:`\text{USD}_{2011}\text{/ft}^2`"
"Capital cost C parameter :math:`^1`", ":math:`C_{circular}`", "construction_c_parameter", "191806", ":math:`\text{USD}_{2011}`"
"Capital cost A parameter :math:`^1`", ":math:`A_{circular}`", "``construction_a_parameter``", "-6e-4", ":math:`\text{USD}_{2011}\text{/ft}^4`"
"Capital cost B parameter :math:`^1`", ":math:`B_{circular}`", "``construction_b_parameter``", "98.952", ":math:`\text{USD}_{2011}\text{/ft}^2`"
"Capital cost C parameter :math:`^1`", ":math:`C_{circular}`", "``construction_c_parameter``", "191806", ":math:`\text{USD}_{2011}`"

"**Rectangular clarifier**"
"Capital cost A parameter :math:`^1`", ":math:`A_{rectangular}`", "construction_a_parameter", "-2.9e-3", ":math:`\text{USD}_{2011}\text{/ft}^4`"
"Capital cost B parameter :math:`^1`", ":math:`B_{rectangular}`", "construction_b_parameter", "169.19", ":math:`\text{USD}_{2011}\text{/ft}^2`"
"Capital cost C parameter :math:`^1`", ":math:`C_{rectangular}`", "construction_c_parameter", "94365", ":math:`\text{USD}_{2011}`"
"Capital cost A parameter :math:`^1`", ":math:`A_{rectangular}`", "``construction_a_parameter``", "-2.9e-3", ":math:`\text{USD}_{2011}\text{/ft}^4`"
"Capital cost B parameter :math:`^1`", ":math:`B_{rectangular}`", "``construction_b_parameter``", "169.19", ":math:`\text{USD}_{2011}\text{/ft}^2`"
"Capital cost C parameter :math:`^1`", ":math:`C_{rectangular}`", "``construction_c_parameter``", "94365", ":math:`\text{USD}_{2011}`"

"**Primary clarifier**"
"Capital cost A parameter :math:`^2`", ":math:`A_{primary}`", "capital_a_parameter", "-2.9e-3", ":math:`\text{USD}_{2021}`"
"Capital cost B parameter :math:`^2`", ":math:`B_{primary}`", "capital_b_parameter", "538746.398", ":math:`\text{dimensionless}`"
"Capital cost A parameter :math:`^2`", ":math:`A_{primary}`", "``capital_a_parameter``", "-2.9e-3", ":math:`\text{USD}_{2021}`"
"Capital cost B parameter :math:`^2`", ":math:`B_{primary}`", "``capital_b_parameter``", "538746.398", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++
Expand All @@ -36,13 +36,13 @@ The following variables are constructed on the unit block (e.g., m.fs.unit.costi
:header: "Description", "Symbol", "Variable Name", "Index", "Units"

"**Circular clarifier**"
"Surface area", ":math:`A_{s}`", "surface_area", "None", ":math:`\text{ft}^2`"
"Surface area", ":math:`A_{s}`", "``surface_area``", "None", ":math:`\text{ft}^2`"

"**Rectangular clarifier**"
"Surface area", ":math:`A_{s}`", "surface_area", "None", ":math:`\text{ft}^2`"
"Surface area", ":math:`A_{s}`", "``surface_area``", "None", ":math:`\text{ft}^2`"

"**Primary clarifier**"
"Inlet volumetric flow rate", ":math:`Q_{in}`", "flow_in", "[t]", ":math:`\text{gal/day}`"
"Inlet volumetric flow rate", ":math:`Q_{in}`", "``flow_in``", "[t]", ":math:`\text{gal/day}`"

Capital Cost Calculations
+++++++++++++++++++++++++
Expand Down
6 changes: 3 additions & 3 deletions docs/technical_reference/costing/compressor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
.. csv-table::
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`"
"description", ":math:`Symbol_{example}`", "``parameter_name``", "1", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++

The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_compressor` costing method in the ``watertap_costing_package``:

.. csv-table::
:header: "Description", "Symbol", "Variable Name", "Default Value", "Units"
:header: "Description", "Symbol", "Variable Name", "Index", "Units"

"description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`"
"description", ":math:`Symbol_{example}`", "``variable_name``", "[t]", ":math:`\text{dimensionless}`"

Capital Cost Calculations
+++++++++++++++++++++++++
Expand Down
20 changes: 10 additions & 10 deletions docs/technical_reference/costing/crystallizer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"**Mass-based Capital Costing**"
"Reference free-on-board (FOB) capital cost :math:`^1`", ":math:`Cost_{ref}`", "fob_unit_cost", "675000", ":math:`\text{USD}_{2007}`"
"Reference crystallizer capacity :math:`^1`", ":math:`size_{ref}`", "ref_capacity", "1", ":math:`\text{kg/s}`"
"Crystallizer cost exponent parameter :math:`^1`", ":math:`n`", "ref_exponent", "0.53", ":math:`\text{dimensionless}`"
"Installed equipment cost factor :math:`^2`", ":math:`IEC`", "iec_percent", "1.43", ":math:`\text{dimensionless}`"
"Reference free-on-board (FOB) capital cost :math:`^1`", ":math:`Cost_{ref}`", "``fob_unit_cost``", "675000", ":math:`\text{USD}_{2007}`"
"Reference crystallizer capacity :math:`^1`", ":math:`size_{ref}`", "``ref_capacity``", "1", ":math:`\text{kg/s}`"
"Crystallizer cost exponent parameter :math:`^1`", ":math:`n`", "``ref_exponent``", "0.53", ":math:`\text{dimensionless}`"
"Installed equipment cost factor :math:`^2`", ":math:`IEC`", "``iec_percent``", "1.43", ":math:`\text{dimensionless}`"

"**Volume-based Capital Costing**"
"Capital cost A parameter :math:`^3`", "A", "volume_cost", "16320", ":math:`\text{USD}_{2007}\text{/ft}^3`"
"Capital cost B parameter :math:`^3`", "B", "vol_basis_exponent", "0.47", ":math:`\text{dimensionless}`"
"Capital cost A parameter :math:`^3`", "A", "``volume_cost``", "16320", ":math:`\text{USD}_{2007}\text{/ft}^3`"
"Capital cost B parameter :math:`^3`", "B", "``vol_basis_exponent``", "0.47", ":math:`\text{dimensionless}`"

"**Operating Costs**"
"Heating steam pressure :math:`^4`", ":math:`P_{steam}`", "steam_pressure", "3", ":math:`\text{bar}`"
"Heating steam cost parameter :math:`^5`", ":math:`Cost_{steam}`", "steam_cost", "0.004", ":math:`\text{USD}_{2018}\text{/m}^3`"
"Recirculation pump head height", ":math:`h_{rec}`", "pump_head_height", "1", ":math:`\text{m}`"
"Recirculation pump efficiency", ":math:`\eta_{pump}`", "efficiency_pump", "0.7", ":math:`\text{dimensionless}`"
"Heating steam pressure :math:`^4`", ":math:`P_{steam}`", "``steam_pressure``", "3", ":math:`\text{bar}`"
"Heating steam cost parameter :math:`^5`", ":math:`Cost_{steam}`", "``steam_cost``", "0.004", ":math:`\text{USD}_{2018}\text{/m}^3`"
"Recirculation pump head height", ":math:`h_{rec}`", "``pump_head_height``", "1", ":math:`\text{m}`"
"Recirculation pump efficiency", ":math:`\eta_{pump}`", "``efficiency_pump``", "0.7", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++
Expand Down
4 changes: 2 additions & 2 deletions docs/technical_reference/costing/cstr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
.. csv-table::
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"Capital cost A parameter :math:`^1`", ":math:`A`", "capital_a_parameter", "1246.1", ":math:`\text{USD}_{1990}`"
"Capital cost B parameter :math:`^1`", ":math:`B`", "capital_b_parameter", "0.71", ":math:`\text{dimensionless}`"
"Capital cost A parameter :math:`^1`", ":math:`A`", "``capital_a_parameter``", "1246.1", ":math:`\text{USD}_{1990}`"
"Capital cost B parameter :math:`^1`", ":math:`B`", "``capital_b_parameter``", "0.71", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++
Expand Down
4 changes: 2 additions & 2 deletions docs/technical_reference/costing/cstr_injection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
.. csv-table::
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"Capital cost A parameter :math:`^1`", ":math:`A`", "capital_a_parameter", "1.1141e3", ":math:`\text{USD}_{1997}`"
"Capital cost B parameter :math:`^1`", ":math:`B`", "capital_b_parameter", "0.6", ":math:`\text{dimensionless}`"
"Capital cost A parameter :math:`^1`", ":math:`A`", "``capital_a_parameter``", "1.1141e3", ":math:`\text{USD}_{1997}`"
"Capital cost B parameter :math:`^1`", ":math:`B`", "``capital_b_parameter``", "0.6", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++
Expand Down
14 changes: 7 additions & 7 deletions docs/technical_reference/costing/dewatering.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"**Centrifuge**"
"Capital cost A parameter :math:`^1`", ":math:`A_{centrifuge}`", "capital_a_parameter", "328.03", ":math:`\text{USD}_{2007}\text{/gal/hr}`"
"Capital cost B parameter :math:`^1`", ":math:`B_{centrifuge}`", "capital_b_parameter", "751295", ":math:`\text{USD}_{2007}`"
"Capital cost A parameter :math:`^1`", ":math:`A_{centrifuge}`", "``capital_a_parameter``", "328.03", ":math:`\text{USD}_{2007}\text{/gal/hr}`"
"Capital cost B parameter :math:`^1`", ":math:`B_{centrifuge}`", "``capital_b_parameter``", "751295", ":math:`\text{USD}_{2007}`"

"**Filter belt press**"
"Capital cost A parameter :math:`^1`", ":math:`A_{fbp}`", "capital_a_parameter", "146.29", ":math:`\text{USD}_{2007}\text{/gal/hr}`"
"Capital cost B parameter :math:`^1`", ":math:`B_{fbp}`", "capital_b_parameter", "433972", ":math:`\text{USD}_{2007}`"
"Capital cost A parameter :math:`^1`", ":math:`A_{fbp}`", "``capital_a_parameter``", "146.29", ":math:`\text{USD}_{2007}\text{/gal/hr}`"
"Capital cost B parameter :math:`^1`", ":math:`B_{fbp}`", "``capital_b_parameter``", "433972", ":math:`\text{USD}_{2007}`"

"**Filter plate press**"
"Capital cost A parameter :math:`^1`", ":math:`A_{fpp}`", "capital_a_parameter", "102794", ":math:`\text{USD}_{2007}\text{/gal/hr}`"
"Capital cost B parameter :math:`^1`", ":math:`B_{fpp}`", "capital_b_parameter", "0.4216", ":math:`\text{USD}_{2007}`"
"Capital cost A parameter :math:`^1`", ":math:`A_{fpp}`", "``capital_a_parameter``", "102794", ":math:`\text{USD}_{2007}\text{/gal/hr}`"
"Capital cost B parameter :math:`^1`", ":math:`B_{fpp}`", "``capital_b_parameter``", "0.4216", ":math:`\text{USD}_{2007}`"

Costing Method Variables
++++++++++++++++++++++++
Expand All @@ -33,7 +33,7 @@ The following variables are constructed on the unit block (e.g., m.fs.unit.costi
.. csv-table::
:header: "Description", "Symbol", "Variable Name", "Index", "Units"

"Inlet volumetric flow rate", ":math:`Q_{in}`", "flow_in", "[t]", ":math:`\text{gal/hr}`"
"Inlet volumetric flow rate", ":math:`Q_{in}`", "``flow_in``", "[t]", ":math:`\text{gal/hr}`"

Capital Cost Calculations
+++++++++++++++++++++++++
Expand Down
14 changes: 7 additions & 7 deletions docs/technical_reference/costing/electroNP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
.. csv-table::
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"Hydraulic retention time", ":math:`HRT`", "HRT", "1.3333", ":math:`\text{hr}`"
"Reactor sizing cost", ":math:`C_V`", "sizing_cost", "1000", ":math:`\text{USD}_{2020}\text{/m}^3`"
"Magnesium chloride cost", ":math:`C_{MgCl2}`", "magnesium_chloride_cost", "0.0786", ":math:`\text{USD}_{2020}\text{/kg}`"
"Phosphorus recovery value*", ":math:`C_{RP}`", "phosphorus_recovery_value", "-0.07", ":math:`\text{USD}_{2020}\text{/kg}`"
"Hydraulic retention time", ":math:`HRT`", "``HRT``", "1.3333", ":math:`\text{hr}`"
"Reactor sizing cost", ":math:`C_V`", "``sizing_cost``", "1000", ":math:`\text{USD}_{2020}\text{/m}^3`"
"Magnesium chloride cost", ":math:`C_{MgCl2}`", "``magnesium_chloride_cost``", "0.0786", ":math:`\text{USD}_{2020}\text{/kg}`"
"Phosphorus recovery value*", ":math:`C_{RP}`", "``phosphorus_recovery_value``", "-0.07", ":math:`\text{USD}_{2020}\text{/kg}`"

\* Negative value represents revenue from recovering phosphorus

Expand All @@ -24,9 +24,9 @@ The following variables are used on the unit block (e.g., m.fs.unit.costing) whe
.. csv-table::
:header: "Description", "Symbol", "Variable Name", "Index", "Units"

"Inlet volumetric flow rate", ":math:`Q_{in}`", "mixed_state[0].flow_vol", "[t]", ":math:`\text{m}^3\text{/hr}`"
"Byproduct phosphate mass flow rate", ":math:`Q_{byproduct, S_{PO4}}`", "byproduct_state[0].conc_mass_comp[0, S_PO4]", "[t]", ":math:`\text{kg/hr}`"
"Magnesium chloride flowrate", ":math:`Q_{MgCl2}`", "magnesium_chloride_dosage", "[t]", ":math:`\text{kg/hr}`"
"Inlet volumetric flow rate", ":math:`Q_{in}`", "``mixed_state[0].flow_vol``", "[t]", ":math:`\text{m}^3\text{/hr}`"
"Byproduct phosphate mass flow rate", ":math:`Q_{byproduct, S_{PO4}}`", "``byproduct_state[0].conc_mass_comp[0, S_PO4]``", "[t]", ":math:`\text{kg/hr}`"
"Magnesium chloride flowrate", ":math:`Q_{MgCl2}`", "``magnesium_chloride_dosage``", "[t]", ":math:`\text{kg/hr}`"

Capital Cost Calculations
+++++++++++++++++++++++++
Expand Down
6 changes: 3 additions & 3 deletions docs/technical_reference/costing/electrodialysis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo
.. csv-table::
:header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"

"description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`"
"description", ":math:`Symbol_{example}`", "``parameter_name``", "1", ":math:`\text{dimensionless}`"

Costing Method Variables
++++++++++++++++++++++++

The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``:

.. csv-table::
:header: "Description", "Symbol", "Variable Name", "Default Value", "Units"
:header: "Description", "Symbol", "Variable Name", "Index", "Units"

"description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`"
"description", ":math:`Symbol_{example}`", "``variable_name``", "[t]", ":math:`\text{dimensionless}`"

Capital Cost Calculations
+++++++++++++++++++++++++
Expand Down
Loading