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

Fix ZO costing method documentation #1081

Merged
merged 5 commits into from
Jul 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The constraint used to calculate energy consumption is described in the Addition

Costing Method
--------------
Costing is calculated using the **cost_CANDOP** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.CANDOP_zo.CANDOPData.cost_CANDOP` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.aeration_basin_zo;aeration_basin_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.air_flotation_zo;air_flotation_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.anaerobic_digestion_oxidation_zo;anaerobic_digestion_oxidation_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_anaerobic_mbr_mec** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.anaerobic_mbr_mec_zo.AnaerobicMBRMECZOData.cost_anaerobic_mbr_mec` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.anaerobic_mbr_mec_zo;anaerobic_mbr_mec_zo
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The constraint used to calculate energy consumption is described in the Addition

Costing Method
--------------
Costing is calculated using the **cost_autothermal_hydrothermal_liquefaction** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.autothermal_hydrothermal_liquefaction_zo.ATHTLZOData.cost_autothermal_hydrothermal_liquefaction` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.backwash_solids_handling_zo;backwash_solids_handling_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.bio_active_filtration_zo;bio_active_filtration_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.bioreactor_zo;bioreactor_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.blending_reservoir_zo;blending_reservoir_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The constraint used to calculate energy consumption is described in the Addition

Costing Method
--------------
Costing is calculated using the **cost_brine_concentrator** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.brine_concentrator_zo.BrineConcentratorZOData.cost_brine_concentrator` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.buffer_tank_zo;buffer_tank_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.cartridge_filtration_zo;cartridge_filtration_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_centrifuge** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.centrifuge_zo.CentrifugeZOData.cost_centrifuge` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The constraint used to calculate energy consumption is described in the Addition

Costing Method
--------------
Costing is calculated using the **cost_chemical_addition** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.chemical_addition_zo.ChemicalAdditionZOData.cost_chemical_addition` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_chlorination** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.chlorination_zo.ChlorinationZOData.cost_chlorination` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.clarifier_zo.ClarifierZOData.cost_clarifier` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.clarifier_zo;clarifier_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.cloth_media_filtration_zo.ClothMediaFiltrationData.cost_cloth_media_filtration` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.cloth_media_filtration_zo;cloth_media_filtration_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.co2_addition_zo;co2_addition_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The constraint used to calculate energy consumption is described in the Addition

Costing Method
--------------
Costing is calculated using the **cost_coag_and_floc** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.coag_and_floc_zo.CoagulationFlocculationZOData.cost_coag_and_floc` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_cofermentation** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.cofermentation_zo.CofermentationZOData.cost_cofermentation` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.cofermentation_zo;cofermentation_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ See documentation for :ref:`single-input, single-output Helper Methods<siso_meth

Costing Method
--------------
Costing is calculated using the **cost_constructed_wetlands** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.constructed_wetlands_zo.ConstructedWetlandsZOData.cost_constructed_wetlands` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.constructed_wetlands_zo;constructed_wetlands_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.conventional_activated_sludge_zo;conventional_activated_sludge_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.cooling_supply_zo;cooling_supply_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.decarbonator_zo;decarbonator_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_deep_well_injection** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.deep_well_injection_zo.DeepWellInjectionZOData.cost_deep_well_injection` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

Additional Variables
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.dissolved_air_flotation_zo;dissolved_air_flotation_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_dmbr** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.unit_models.zero_order.dmbr_zo.DMBRZOOData.cost_dmbr` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.dmbr_zo;dmbr_zo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ See documentation for :ref:`Helper Methods for Electricity Demand<electricity_me

Costing Method
--------------
Costing is calculated using the **cost_power_law_flow** method in the zero-order costing package.
See documentation for the :ref:`zero-order costing package<zero_order_costing>`.
Costing is calculated using the :py:meth:`~watertap.core.zero_order_base.ZeroOrderBaseData.cost_power_law_flow` method.
For full details on costing, see documentation for the :ref:`zero-order costing package<zero_order_costing>`.

.. index::
pair: watertap.unit_models.zero_order.dual_media_filtration_zo;dual_media_filtration_zo
Expand Down
Loading
Loading