From a18fc07bdea38fd2ba66c42be45bc9fade00497c Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Thu, 18 Apr 2024 12:33:55 -0400 Subject: [PATCH 01/15] fix typo in costing_base.rst for heater/chiller costing method --- docs/technical_reference/costing/costing_base.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/technical_reference/costing/costing_base.rst b/docs/technical_reference/costing/costing_base.rst index d8424f120a..7385c3a41e 100644 --- a/docs/technical_reference/costing/costing_base.rst +++ b/docs/technical_reference/costing/costing_base.rst @@ -392,7 +392,7 @@ While the expectation is that unit models use the self-registration process note * Mixer - :py:func:`watertap.costing.unit_models.mixer.cost_mixer` * HeatExchanger - :py:func:`watertap.costing.unit_models.heat_exchanger.cost_heat_exchanger` * CSTR - :py:func:`watertap.costing.unit_models.cstr.cost_cstr` -* Heater - :py:func:`watertap.costing.unit_models.heater_ciller.cost_heater_ciller` +* Heater - :py:func:`watertap.costing.unit_models.heater_chiller.cost_heater_chiller` Class Documentation From 49046e61268a332fc03bf9993f3913c8cfa4192d Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Thu, 18 Apr 2024 14:09:48 -0400 Subject: [PATCH 02/15] add index --- .../costing/detailed_unit_model_costing.rst | 6 ++++++ docs/technical_reference/costing/index.rst | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 docs/technical_reference/costing/detailed_unit_model_costing.rst diff --git a/docs/technical_reference/costing/detailed_unit_model_costing.rst b/docs/technical_reference/costing/detailed_unit_model_costing.rst new file mode 100644 index 0000000000..dd6629f7d1 --- /dev/null +++ b/docs/technical_reference/costing/detailed_unit_model_costing.rst @@ -0,0 +1,6 @@ +Detailed Unit Model Costing +=========================== +Default costing is provided for the unit model listed below. However, users should supply their own cost relationship, if possible, instead of relying completely on the defaults. + +.. toctree:: + :maxdepth: 1 \ No newline at end of file diff --git a/docs/technical_reference/costing/index.rst b/docs/technical_reference/costing/index.rst index b548657dc4..43bfedc656 100644 --- a/docs/technical_reference/costing/index.rst +++ b/docs/technical_reference/costing/index.rst @@ -1,4 +1,4 @@ -Costing Components +Costing Models ================== .. toctree:: @@ -7,6 +7,7 @@ Costing Components costing_base watertap_costing watertap_costing_detailed + detailed_unit_model_costing zero_order_costing multiple_choice_costing_block - util + util \ No newline at end of file From 22ab641e33cd1b1b845b32e9bf33c12772f7b5af Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Thu, 18 Apr 2024 16:10:38 -0400 Subject: [PATCH 03/15] add unit costing doc templates --- .../costing/WT_unit_costing_for_docs.csv | 27 +++++ .../costing/anaerobic_digester.rst | 28 ++++++ ...automate_detailed_unit_costing_rst_file.py | 99 +++++++++++++++++++ .../technical_reference/costing/clarifier.rst | 28 ++++++ .../costing/compressor.rst | 28 ++++++ .../costing/crystallizer.rst | 28 ++++++ docs/technical_reference/costing/cstr.rst | 28 ++++++ .../costing/cstr_injection.rst | 28 ++++++ .../costing/detailed_unit_model_costing.rst | 31 +++++- .../costing/dewatering.rst | 28 ++++++ .../technical_reference/costing/electroNP.rst | 28 ++++++ .../costing/electrodialysis.rst | 28 ++++++ .../costing/electrolyzer.rst | 28 ++++++ .../costing/energy_recovery_device.rst | 28 ++++++ .../costing/evaporator.rst | 28 ++++++ docs/technical_reference/costing/gac.rst | 28 ++++++ .../costing/heat_exchanger.rst | 28 ++++++ .../costing/heater_chiller.rst | 28 ++++++ .../costing/ion_exchange.rst | 28 ++++++ .../costing/membrane_distillation.rst | 28 ++++++ docs/technical_reference/costing/mixer.rst | 28 ++++++ .../costing/nanofiltration.rst | 28 ++++++ .../osmotically_assisted_reverse_osmosis.rst | 28 ++++++ .../costing/pressure_exchanger.rst | 28 ++++++ docs/technical_reference/costing/pump.rst | 28 ++++++ .../costing/reverse_osmosis.rst | 28 ++++++ .../costing/stoichiometric_reactor.rst | 28 ++++++ .../technical_reference/costing/thickener.rst | 28 ++++++ docs/technical_reference/costing/uv_aop.rst | 28 ++++++ 29 files changed, 883 insertions(+), 2 deletions(-) create mode 100644 docs/technical_reference/costing/WT_unit_costing_for_docs.csv create mode 100644 docs/technical_reference/costing/anaerobic_digester.rst create mode 100644 docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py create mode 100644 docs/technical_reference/costing/clarifier.rst create mode 100644 docs/technical_reference/costing/compressor.rst create mode 100644 docs/technical_reference/costing/crystallizer.rst create mode 100644 docs/technical_reference/costing/cstr.rst create mode 100644 docs/technical_reference/costing/cstr_injection.rst create mode 100644 docs/technical_reference/costing/dewatering.rst create mode 100644 docs/technical_reference/costing/electroNP.rst create mode 100644 docs/technical_reference/costing/electrodialysis.rst create mode 100644 docs/technical_reference/costing/electrolyzer.rst create mode 100644 docs/technical_reference/costing/energy_recovery_device.rst create mode 100644 docs/technical_reference/costing/evaporator.rst create mode 100644 docs/technical_reference/costing/gac.rst create mode 100644 docs/technical_reference/costing/heat_exchanger.rst create mode 100644 docs/technical_reference/costing/heater_chiller.rst create mode 100644 docs/technical_reference/costing/ion_exchange.rst create mode 100644 docs/technical_reference/costing/membrane_distillation.rst create mode 100644 docs/technical_reference/costing/mixer.rst create mode 100644 docs/technical_reference/costing/nanofiltration.rst create mode 100644 docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst create mode 100644 docs/technical_reference/costing/pressure_exchanger.rst create mode 100644 docs/technical_reference/costing/pump.rst create mode 100644 docs/technical_reference/costing/reverse_osmosis.rst create mode 100644 docs/technical_reference/costing/stoichiometric_reactor.rst create mode 100644 docs/technical_reference/costing/thickener.rst create mode 100644 docs/technical_reference/costing/uv_aop.rst diff --git a/docs/technical_reference/costing/WT_unit_costing_for_docs.csv b/docs/technical_reference/costing/WT_unit_costing_for_docs.csv new file mode 100644 index 0000000000..2228fd66f4 --- /dev/null +++ b/docs/technical_reference/costing/WT_unit_costing_for_docs.csv @@ -0,0 +1,27 @@ +name,unit +anaerobic digester,anaerobic_digester +clarifier,clarifier +compressor,compressor +crystallizer,crystallizer +cstr injection,cstr_injection +cstr,cstr +dewatering,dewatering +electrodialysis,electrodialysis +electrolyzer,electrolyzer +electroNP,electroNP +energy recovery device,energy_recovery_device +evaporator,evaporator +gac,gac +heat exchanger,heat_exchanger +heater chiller,heater_chiller +ion exchange,ion_exchange +membrane distillation,membrane_distillation +mixer,mixer +nanofiltration,nanofiltration +osmotically assisted reverse osmosis,osmotically_assisted_reverse_osmosis +pressure exchanger,pressure_exchanger +pump,pump +reverse osmosis,reverse_osmosis +stoichiometric reactor,stoichiometric_reactor +thickener,thickener +uv aop,uv_aop diff --git a/docs/technical_reference/costing/anaerobic_digester.rst b/docs/technical_reference/costing/anaerobic_digester.rst new file mode 100644 index 0000000000..30ee1a082c --- /dev/null +++ b/docs/technical_reference/costing/anaerobic_digester.rst @@ -0,0 +1,28 @@ +Anaerobic Digester Costing Method +================================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py new file mode 100644 index 0000000000..c9b6040fd7 --- /dev/null +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -0,0 +1,99 @@ +################################################################################# +# WaterTAP Copyright (c) 2020-2024, The Regents of the University of California, +# through Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory, +# National Renewable Energy Laboratory, and National Energy Technology +# Laboratory (subject to receipt of any required approvals from the U.S. Dept. +# of Energy). All rights reserved. +# +# Please see the files COPYRIGHT.md and LICENSE.md for full copyright and license +# information, respectively. These files are also available online at the URL +# "https://github.com/watertap-org/watertap/" +################################################################################# + +__author__ = "Adam Atia" + +import pandas as pd + +df = pd.read_csv("WT_unit_costing_for_docs.csv") + +unit_title_list = [i.title() for i in df["name"]] + +unit_name_list = df["unit"] + +title_exceptions = { + "cstr_injection": "Completely Stirred Tank Reactor w/Injection Stream", + "cstr": "Completely Stirred Tank Reactor", + "dewatering": "Dewatering Unit", + "electroNP": "ElectroN-P", + "gac": "Granular Activated Carbon", + "heater_chiller": "Heater/Chiller", + "uv_aop": "UV with Advanced Oxidation Processes", +} + + +if __name__ == "__main__": + + # Create index file for all unit model costing docs + with open("detailed_unit_model_costing.rst", "w") as f: + f.write("Detailed Unit Model Costing\n") + f.write("=" * len("Detailed Unit Model Costing")) + f.write("\n") + f.write( + "Default costing methods are provided for the unit models listed below. However, users should supply their own cost relationship, if possible, instead of relying completely on the defaults.\n\n" + ) + f.write(".. toctree::\n") + f.write(" :maxdepth: 1\n\n") + + for i, u in enumerate(unit_title_list): + + # list = [ + # f"This unit model is formulated as a **{model_type_list[i]}** model form.", + # f"See documentation for :ref:`{model_type_list[i]} Helper Methods<{model_type_ref_list[i]}>`.", + # f"Electricity consumption is calculated using the **{elect_func_list[i]}** helper function.", + # None, # created on the fly now + # f" pair: watertap.unit_models.zero_order.{unit_name_list[i]};{unit_name_list[i]}", + # f".. currentmodule:: watertap.unit_models.zero_order.{unit_name_list[i]}", + # f".. automodule:: watertap.unit_models.zero_order.{unit_name_list[i]}", + # ] + + # append unit doc to index + with open("detailed_unit_model_costing.rst", "a") as f: + f.write(f" {unit_name_list[i]}\n") + + with open(f"{unit_name_list[i]}.rst", "w", encoding="utf-8") as f: + # write doc title based on unit name + if unit_name_list[i] in title_exceptions: + f.write(f"{title_exceptions[unit_name_list[i]]} Costing Method") + f.write("\n") + f.write("=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method")) + else: + f.write(f"{unit_title_list[i]} Costing Method") + f.write("\n") + f.write("=" * len(f"{unit_title_list[i]} Costing Method")) + f.write("\n") + + #TODO: add parameter tables + f.write("\nCosting Method Parameters\n") + f.write("+" * len("Costing Method Parameters")) + f.write(f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n") + + #TODO: add var tables + f.write("\n\nCosting Method Variables\n") + f.write("+" * len("Costing Method Variables")) + f.write(f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n") + + #TODO: add capex eqs + f.write("\n\nCapital Cost Calculations\n") + f.write("+" * len("Capital Cost Calculations")) + + #TODO: add opex eqs + f.write("\n\nOperating Cost Calculations\n") + f.write("+" * len("Operating Cost Calculations")) + + #TODO: add module directives to unit and cost method + f.write("\n\nCode Documentation\n") + f.write("-" * len("Code Documentation")) + + f.write("\n\nReferences\n") + f.write("-" * len("References")) + f.write("\n") diff --git a/docs/technical_reference/costing/clarifier.rst b/docs/technical_reference/costing/clarifier.rst new file mode 100644 index 0000000000..bc51128013 --- /dev/null +++ b/docs/technical_reference/costing/clarifier.rst @@ -0,0 +1,28 @@ +Clarifier Costing Method +======================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/compressor.rst b/docs/technical_reference/costing/compressor.rst new file mode 100644 index 0000000000..4be7cbd5a9 --- /dev/null +++ b/docs/technical_reference/costing/compressor.rst @@ -0,0 +1,28 @@ +Compressor Costing Method +========================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_compressor` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_compressor` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/crystallizer.rst b/docs/technical_reference/costing/crystallizer.rst new file mode 100644 index 0000000000..7d806c884c --- /dev/null +++ b/docs/technical_reference/costing/crystallizer.rst @@ -0,0 +1,28 @@ +Crystallizer Costing Method +=========================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/cstr.rst b/docs/technical_reference/costing/cstr.rst new file mode 100644 index 0000000000..847b2d3426 --- /dev/null +++ b/docs/technical_reference/costing/cstr.rst @@ -0,0 +1,28 @@ +Completely Stirred Tank Reactor Costing Method +============================================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_cstr` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_cstr` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/cstr_injection.rst b/docs/technical_reference/costing/cstr_injection.rst new file mode 100644 index 0000000000..d38491077e --- /dev/null +++ b/docs/technical_reference/costing/cstr_injection.rst @@ -0,0 +1,28 @@ +Completely Stirred Tank Reactor w/Injection Stream Costing Method +================================================================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/detailed_unit_model_costing.rst b/docs/technical_reference/costing/detailed_unit_model_costing.rst index dd6629f7d1..894befc2af 100644 --- a/docs/technical_reference/costing/detailed_unit_model_costing.rst +++ b/docs/technical_reference/costing/detailed_unit_model_costing.rst @@ -1,6 +1,33 @@ Detailed Unit Model Costing =========================== -Default costing is provided for the unit model listed below. However, users should supply their own cost relationship, if possible, instead of relying completely on the defaults. +Default costing methods are provided for the unit models listed below. However, users should supply their own cost relationship, if possible, instead of relying completely on the defaults. .. toctree:: - :maxdepth: 1 \ No newline at end of file + :maxdepth: 1 + + anaerobic_digester + clarifier + compressor + crystallizer + cstr_injection + cstr + dewatering + electrodialysis + electrolyzer + electroNP + energy_recovery_device + evaporator + gac + heat_exchanger + heater_chiller + ion_exchange + membrane_distillation + mixer + nanofiltration + osmotically_assisted_reverse_osmosis + pressure_exchanger + pump + reverse_osmosis + stoichiometric_reactor + thickener + uv_aop diff --git a/docs/technical_reference/costing/dewatering.rst b/docs/technical_reference/costing/dewatering.rst new file mode 100644 index 0000000000..9c46581060 --- /dev/null +++ b/docs/technical_reference/costing/dewatering.rst @@ -0,0 +1,28 @@ +Dewatering Unit Costing Method +============================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/electroNP.rst b/docs/technical_reference/costing/electroNP.rst new file mode 100644 index 0000000000..9022bc042b --- /dev/null +++ b/docs/technical_reference/costing/electroNP.rst @@ -0,0 +1,28 @@ +ElectroN-P Costing Method +========================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/electrodialysis.rst b/docs/technical_reference/costing/electrodialysis.rst new file mode 100644 index 0000000000..f37a905e30 --- /dev/null +++ b/docs/technical_reference/costing/electrodialysis.rst @@ -0,0 +1,28 @@ +Electrodialysis Costing Method +============================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/electrolyzer.rst b/docs/technical_reference/costing/electrolyzer.rst new file mode 100644 index 0000000000..7007f353d9 --- /dev/null +++ b/docs/technical_reference/costing/electrolyzer.rst @@ -0,0 +1,28 @@ +Electrolyzer Costing Method +=========================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/energy_recovery_device.rst b/docs/technical_reference/costing/energy_recovery_device.rst new file mode 100644 index 0000000000..338a9cc2d8 --- /dev/null +++ b/docs/technical_reference/costing/energy_recovery_device.rst @@ -0,0 +1,28 @@ +Energy Recovery Device Costing Method +===================================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/evaporator.rst b/docs/technical_reference/costing/evaporator.rst new file mode 100644 index 0000000000..8853b2c3a2 --- /dev/null +++ b/docs/technical_reference/costing/evaporator.rst @@ -0,0 +1,28 @@ +Evaporator Costing Method +========================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/gac.rst b/docs/technical_reference/costing/gac.rst new file mode 100644 index 0000000000..9025b8deb4 --- /dev/null +++ b/docs/technical_reference/costing/gac.rst @@ -0,0 +1,28 @@ +Granular Activated Carbon Costing Method +======================================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_gac` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_gac` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/heat_exchanger.rst b/docs/technical_reference/costing/heat_exchanger.rst new file mode 100644 index 0000000000..efcc29fcbe --- /dev/null +++ b/docs/technical_reference/costing/heat_exchanger.rst @@ -0,0 +1,28 @@ +Heat Exchanger Costing Method +============================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/heater_chiller.rst b/docs/technical_reference/costing/heater_chiller.rst new file mode 100644 index 0000000000..4bf88cb78a --- /dev/null +++ b/docs/technical_reference/costing/heater_chiller.rst @@ -0,0 +1,28 @@ +Heater/Chiller Costing Method +============================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/ion_exchange.rst b/docs/technical_reference/costing/ion_exchange.rst new file mode 100644 index 0000000000..32ce70124e --- /dev/null +++ b/docs/technical_reference/costing/ion_exchange.rst @@ -0,0 +1,28 @@ +Ion Exchange Costing Method +=========================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/membrane_distillation.rst b/docs/technical_reference/costing/membrane_distillation.rst new file mode 100644 index 0000000000..ffe8039b9d --- /dev/null +++ b/docs/technical_reference/costing/membrane_distillation.rst @@ -0,0 +1,28 @@ +Membrane Distillation Costing Method +==================================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/mixer.rst b/docs/technical_reference/costing/mixer.rst new file mode 100644 index 0000000000..29425433b0 --- /dev/null +++ b/docs/technical_reference/costing/mixer.rst @@ -0,0 +1,28 @@ +Mixer Costing Method +==================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_mixer` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_mixer` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/nanofiltration.rst b/docs/technical_reference/costing/nanofiltration.rst new file mode 100644 index 0000000000..5d031a17d8 --- /dev/null +++ b/docs/technical_reference/costing/nanofiltration.rst @@ -0,0 +1,28 @@ +Nanofiltration Costing Method +============================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst new file mode 100644 index 0000000000..0c3975378e --- /dev/null +++ b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst @@ -0,0 +1,28 @@ +Osmotically Assisted Reverse Osmosis Costing Method +=================================================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/pressure_exchanger.rst b/docs/technical_reference/costing/pressure_exchanger.rst new file mode 100644 index 0000000000..6d3f1e551b --- /dev/null +++ b/docs/technical_reference/costing/pressure_exchanger.rst @@ -0,0 +1,28 @@ +Pressure Exchanger Costing Method +================================= + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/pump.rst b/docs/technical_reference/costing/pump.rst new file mode 100644 index 0000000000..01f5aa3950 --- /dev/null +++ b/docs/technical_reference/costing/pump.rst @@ -0,0 +1,28 @@ +Pump Costing Method +=================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_pump` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_pump` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/reverse_osmosis.rst b/docs/technical_reference/costing/reverse_osmosis.rst new file mode 100644 index 0000000000..ebd18bd096 --- /dev/null +++ b/docs/technical_reference/costing/reverse_osmosis.rst @@ -0,0 +1,28 @@ +Reverse Osmosis Costing Method +============================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/stoichiometric_reactor.rst b/docs/technical_reference/costing/stoichiometric_reactor.rst new file mode 100644 index 0000000000..a8645b103b --- /dev/null +++ b/docs/technical_reference/costing/stoichiometric_reactor.rst @@ -0,0 +1,28 @@ +Stoichiometric Reactor Costing Method +===================================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/thickener.rst b/docs/technical_reference/costing/thickener.rst new file mode 100644 index 0000000000..cf35ac9a5e --- /dev/null +++ b/docs/technical_reference/costing/thickener.rst @@ -0,0 +1,28 @@ +Thickener Costing Method +======================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_thickener` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_thickener` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- diff --git a/docs/technical_reference/costing/uv_aop.rst b/docs/technical_reference/costing/uv_aop.rst new file mode 100644 index 0000000000..8158de637c --- /dev/null +++ b/docs/technical_reference/costing/uv_aop.rst @@ -0,0 +1,28 @@ +UV with Advanced Oxidation Processes Costing Method +=================================================== + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: + + + +Costing Method Variables +++++++++++++++++++++++++ + +The following variables are constructed when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: + + + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +Code Documentation +------------------ + +References +---------- From 0ca6d9185f3c8d8f19b565dfee1f6b7fdef4a031 Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Thu, 18 Apr 2024 16:31:48 -0400 Subject: [PATCH 04/15] black --- ...automate_detailed_unit_costing_rst_file.py | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index c9b6040fd7..e95a3c30bd 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -65,32 +65,38 @@ if unit_name_list[i] in title_exceptions: f.write(f"{title_exceptions[unit_name_list[i]]} Costing Method") f.write("\n") - f.write("=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method")) + f.write( + "=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method") + ) else: f.write(f"{unit_title_list[i]} Costing Method") f.write("\n") f.write("=" * len(f"{unit_title_list[i]} Costing Method")) f.write("\n") - #TODO: add parameter tables + # TODO: add parameter tables f.write("\nCosting Method Parameters\n") f.write("+" * len("Costing Method Parameters")) - f.write(f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n") - - #TODO: add var tables + f.write( + f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" + ) + + # TODO: add var tables f.write("\n\nCosting Method Variables\n") f.write("+" * len("Costing Method Variables")) - f.write(f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n") + f.write( + f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" + ) - #TODO: add capex eqs + # TODO: add capex eqs f.write("\n\nCapital Cost Calculations\n") f.write("+" * len("Capital Cost Calculations")) - #TODO: add opex eqs + # TODO: add opex eqs f.write("\n\nOperating Cost Calculations\n") f.write("+" * len("Operating Cost Calculations")) - #TODO: add module directives to unit and cost method + # TODO: add module directives to unit and cost method f.write("\n\nCode Documentation\n") f.write("-" * len("Code Documentation")) From 5b06d5d29e17c60d04045a1ce66e20d3cb6cf17c Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Sat, 20 Apr 2024 16:02:04 -0400 Subject: [PATCH 05/15] Complete template and put up for review --- .../costing/anaerobic_digester.rst | 34 ++++++++++++- ...automate_detailed_unit_costing_rst_file.py | 48 +++++++++++-------- .../technical_reference/costing/clarifier.rst | 34 ++++++++++++- .../costing/compressor.rst | 34 ++++++++++++- .../costing/crystallizer.rst | 34 ++++++++++++- docs/technical_reference/costing/cstr.rst | 34 ++++++++++++- .../costing/cstr_injection.rst | 34 ++++++++++++- .../costing/dewatering.rst | 34 ++++++++++++- .../technical_reference/costing/electroNP.rst | 34 ++++++++++++- .../costing/electrodialysis.rst | 34 ++++++++++++- .../costing/electrolyzer.rst | 34 ++++++++++++- .../costing/energy_recovery_device.rst | 34 ++++++++++++- .../costing/evaporator.rst | 34 ++++++++++++- docs/technical_reference/costing/gac.rst | 34 ++++++++++++- .../costing/heat_exchanger.rst | 34 ++++++++++++- .../costing/heater_chiller.rst | 34 ++++++++++++- .../costing/ion_exchange.rst | 34 ++++++++++++- .../costing/membrane_distillation.rst | 34 ++++++++++++- docs/technical_reference/costing/mixer.rst | 34 ++++++++++++- .../costing/nanofiltration.rst | 34 ++++++++++++- .../osmotically_assisted_reverse_osmosis.rst | 34 ++++++++++++- .../costing/pressure_exchanger.rst | 34 ++++++++++++- docs/technical_reference/costing/pump.rst | 34 ++++++++++++- .../costing/reverse_osmosis.rst | 34 ++++++++++++- .../costing/stoichiometric_reactor.rst | 34 ++++++++++++- .../technical_reference/costing/thickener.rst | 34 ++++++++++++- docs/technical_reference/costing/uv_aop.rst | 34 ++++++++++++- 27 files changed, 886 insertions(+), 46 deletions(-) diff --git a/docs/technical_reference/costing/anaerobic_digester.rst b/docs/technical_reference/costing/anaerobic_digester.rst index 30ee1a082c..051d85a687 100644 --- a/docs/technical_reference/costing/anaerobic_digester.rst +++ b/docs/technical_reference/costing/anaerobic_digester.rst @@ -1,28 +1,60 @@ Anaerobic Digester Costing Method -================================= +================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.anaerobic_digester` +* :mod:`watertap.costing.unit_models.anaerobic_digester` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index e95a3c30bd..8c701d73f9 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -46,15 +46,6 @@ for i, u in enumerate(unit_title_list): - # list = [ - # f"This unit model is formulated as a **{model_type_list[i]}** model form.", - # f"See documentation for :ref:`{model_type_list[i]} Helper Methods<{model_type_ref_list[i]}>`.", - # f"Electricity consumption is calculated using the **{elect_func_list[i]}** helper function.", - # None, # created on the fly now - # f" pair: watertap.unit_models.zero_order.{unit_name_list[i]};{unit_name_list[i]}", - # f".. currentmodule:: watertap.unit_models.zero_order.{unit_name_list[i]}", - # f".. automodule:: watertap.unit_models.zero_order.{unit_name_list[i]}", - # ] # append unit doc to index with open("detailed_unit_model_costing.rst", "a") as f: @@ -66,40 +57,57 @@ f.write(f"{title_exceptions[unit_name_list[i]]} Costing Method") f.write("\n") f.write( - "=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method") + "=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method\n") ) else: f.write(f"{unit_title_list[i]} Costing Method") f.write("\n") - f.write("=" * len(f"{unit_title_list[i]} Costing Method")) - f.write("\n") + f.write("=" * len(f"{unit_title_list[i]} Costing Method\n")) # TODO: add parameter tables - f.write("\nCosting Method Parameters\n") + f.write("\n\nCosting Method Parameters\n") f.write("+" * len("Costing Method Parameters")) f.write( f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" ) + f.write(".. csv-table::\n") + f.write(' :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"\n\n') + f.write(' "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\\text{dimensionless}`"\n') # TODO: add var tables - f.write("\n\nCosting Method Variables\n") + f.write("\nCosting Method Variables\n") f.write("+" * len("Costing Method Variables")) f.write( f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" ) + f.write(".. csv-table::\n") + f.write(' :header: "Description", "Symbol", "Variable Name", "Default Value", "Units"\n\n') + f.write(' "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\\text{dimensionless}`"\n') # TODO: add capex eqs - f.write("\n\nCapital Cost Calculations\n") + f.write("\nCapital Cost Calculations\n") f.write("+" * len("Capital Cost Calculations")) - + f.write("\n\nDescribe capital costs..keep it concise where possible\n\n") + f.write(" .. math::\n\n") + f.write(" C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other}") + f.write("\n\n .. math::\n\n") + f.write(" & C_{cap,example1} = fill in equation for each component in total capex equation\n\n ") + # TODO: add opex eqs - f.write("\n\nOperating Cost Calculations\n") + f.write("\nOperating Cost Calculations\n") f.write("+" * len("Operating Cost Calculations")) - + f.write("\n\nDescribe operating/maintenance costs..keep it concise where possible\n\n") + f.write(" .. math::\n\n") + f.write(" C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other}") + f.write("\n\n .. math::\n\n") + f.write(" & C_{op,example1} = fill in equation for each component in total opex equation\n\n ") + # TODO: add module directives to unit and cost method - f.write("\n\nCode Documentation\n") + f.write("\nCode Documentation\n") f.write("-" * len("Code Documentation")) + f.write(f"\n\n* :mod:`watertap.unit_models.{unit_name_list[i]}`") + f.write(f"\n* :mod:`watertap.costing.unit_models.{unit_name_list[i]}`") f.write("\n\nReferences\n") f.write("-" * len("References")) - f.write("\n") + f.write("\nAim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values") diff --git a/docs/technical_reference/costing/clarifier.rst b/docs/technical_reference/costing/clarifier.rst index bc51128013..73ffc6ff89 100644 --- a/docs/technical_reference/costing/clarifier.rst +++ b/docs/technical_reference/costing/clarifier.rst @@ -1,28 +1,60 @@ Clarifier Costing Method -======================== +========================= Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.clarifier` +* :mod:`watertap.costing.unit_models.clarifier` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/compressor.rst b/docs/technical_reference/costing/compressor.rst index 4be7cbd5a9..e8582e4bbf 100644 --- a/docs/technical_reference/costing/compressor.rst +++ b/docs/technical_reference/costing/compressor.rst @@ -1,28 +1,60 @@ Compressor Costing Method -========================= +========================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_compressor` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_compressor` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.compressor` +* :mod:`watertap.costing.unit_models.compressor` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/crystallizer.rst b/docs/technical_reference/costing/crystallizer.rst index 7d806c884c..cead5c3933 100644 --- a/docs/technical_reference/costing/crystallizer.rst +++ b/docs/technical_reference/costing/crystallizer.rst @@ -1,28 +1,60 @@ Crystallizer Costing Method -=========================== +============================ Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.crystallizer` +* :mod:`watertap.costing.unit_models.crystallizer` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/cstr.rst b/docs/technical_reference/costing/cstr.rst index 847b2d3426..bd58391b1f 100644 --- a/docs/technical_reference/costing/cstr.rst +++ b/docs/technical_reference/costing/cstr.rst @@ -1,28 +1,60 @@ Completely Stirred Tank Reactor Costing Method -============================================== +=============================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_cstr` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_cstr` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.cstr` +* :mod:`watertap.costing.unit_models.cstr` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/cstr_injection.rst b/docs/technical_reference/costing/cstr_injection.rst index d38491077e..3e8fa8e1ac 100644 --- a/docs/technical_reference/costing/cstr_injection.rst +++ b/docs/technical_reference/costing/cstr_injection.rst @@ -1,28 +1,60 @@ Completely Stirred Tank Reactor w/Injection Stream Costing Method -================================================================= +================================================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.cstr_injection` +* :mod:`watertap.costing.unit_models.cstr_injection` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/dewatering.rst b/docs/technical_reference/costing/dewatering.rst index 9c46581060..8cbeb30814 100644 --- a/docs/technical_reference/costing/dewatering.rst +++ b/docs/technical_reference/costing/dewatering.rst @@ -1,28 +1,60 @@ Dewatering Unit Costing Method -============================== +=============================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.dewatering` +* :mod:`watertap.costing.unit_models.dewatering` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/electroNP.rst b/docs/technical_reference/costing/electroNP.rst index 9022bc042b..d6e87dd29a 100644 --- a/docs/technical_reference/costing/electroNP.rst +++ b/docs/technical_reference/costing/electroNP.rst @@ -1,28 +1,60 @@ ElectroN-P Costing Method -========================= +========================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.electroNP` +* :mod:`watertap.costing.unit_models.electroNP` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/electrodialysis.rst b/docs/technical_reference/costing/electrodialysis.rst index f37a905e30..9be1dbbf64 100644 --- a/docs/technical_reference/costing/electrodialysis.rst +++ b/docs/technical_reference/costing/electrodialysis.rst @@ -1,28 +1,60 @@ Electrodialysis Costing Method -============================== +=============================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.electrodialysis` +* :mod:`watertap.costing.unit_models.electrodialysis` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/electrolyzer.rst b/docs/technical_reference/costing/electrolyzer.rst index 7007f353d9..198cb67db6 100644 --- a/docs/technical_reference/costing/electrolyzer.rst +++ b/docs/technical_reference/costing/electrolyzer.rst @@ -1,28 +1,60 @@ Electrolyzer Costing Method -=========================== +============================ Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.electrolyzer` +* :mod:`watertap.costing.unit_models.electrolyzer` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/energy_recovery_device.rst b/docs/technical_reference/costing/energy_recovery_device.rst index 338a9cc2d8..9a133a4d13 100644 --- a/docs/technical_reference/costing/energy_recovery_device.rst +++ b/docs/technical_reference/costing/energy_recovery_device.rst @@ -1,28 +1,60 @@ Energy Recovery Device Costing Method -===================================== +====================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.energy_recovery_device` +* :mod:`watertap.costing.unit_models.energy_recovery_device` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/evaporator.rst b/docs/technical_reference/costing/evaporator.rst index 8853b2c3a2..6cdb5862a9 100644 --- a/docs/technical_reference/costing/evaporator.rst +++ b/docs/technical_reference/costing/evaporator.rst @@ -1,28 +1,60 @@ Evaporator Costing Method -========================= +========================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.evaporator` +* :mod:`watertap.costing.unit_models.evaporator` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/gac.rst b/docs/technical_reference/costing/gac.rst index 9025b8deb4..f43871e537 100644 --- a/docs/technical_reference/costing/gac.rst +++ b/docs/technical_reference/costing/gac.rst @@ -1,28 +1,60 @@ Granular Activated Carbon Costing Method -======================================== +========================================= Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_gac` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_gac` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.gac` +* :mod:`watertap.costing.unit_models.gac` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/heat_exchanger.rst b/docs/technical_reference/costing/heat_exchanger.rst index efcc29fcbe..b647293c77 100644 --- a/docs/technical_reference/costing/heat_exchanger.rst +++ b/docs/technical_reference/costing/heat_exchanger.rst @@ -1,28 +1,60 @@ Heat Exchanger Costing Method -============================= +============================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.heat_exchanger` +* :mod:`watertap.costing.unit_models.heat_exchanger` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/heater_chiller.rst b/docs/technical_reference/costing/heater_chiller.rst index 4bf88cb78a..5d38b05762 100644 --- a/docs/technical_reference/costing/heater_chiller.rst +++ b/docs/technical_reference/costing/heater_chiller.rst @@ -1,28 +1,60 @@ Heater/Chiller Costing Method -============================= +============================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.heater_chiller` +* :mod:`watertap.costing.unit_models.heater_chiller` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/ion_exchange.rst b/docs/technical_reference/costing/ion_exchange.rst index 32ce70124e..c7b2589b15 100644 --- a/docs/technical_reference/costing/ion_exchange.rst +++ b/docs/technical_reference/costing/ion_exchange.rst @@ -1,28 +1,60 @@ Ion Exchange Costing Method -=========================== +============================ Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.ion_exchange` +* :mod:`watertap.costing.unit_models.ion_exchange` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/membrane_distillation.rst b/docs/technical_reference/costing/membrane_distillation.rst index ffe8039b9d..c9474a1835 100644 --- a/docs/technical_reference/costing/membrane_distillation.rst +++ b/docs/technical_reference/costing/membrane_distillation.rst @@ -1,28 +1,60 @@ Membrane Distillation Costing Method -==================================== +===================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.membrane_distillation` +* :mod:`watertap.costing.unit_models.membrane_distillation` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/mixer.rst b/docs/technical_reference/costing/mixer.rst index 29425433b0..7886aa548f 100644 --- a/docs/technical_reference/costing/mixer.rst +++ b/docs/technical_reference/costing/mixer.rst @@ -1,28 +1,60 @@ Mixer Costing Method -==================== +===================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_mixer` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_mixer` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.mixer` +* :mod:`watertap.costing.unit_models.mixer` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/nanofiltration.rst b/docs/technical_reference/costing/nanofiltration.rst index 5d031a17d8..d8a0313155 100644 --- a/docs/technical_reference/costing/nanofiltration.rst +++ b/docs/technical_reference/costing/nanofiltration.rst @@ -1,28 +1,60 @@ Nanofiltration Costing Method -============================= +============================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.nanofiltration` +* :mod:`watertap.costing.unit_models.nanofiltration` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst index 0c3975378e..16303e3d64 100644 --- a/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst +++ b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst @@ -1,28 +1,60 @@ Osmotically Assisted Reverse Osmosis Costing Method -=================================================== +==================================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.osmotically_assisted_reverse_osmosis` +* :mod:`watertap.costing.unit_models.osmotically_assisted_reverse_osmosis` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/pressure_exchanger.rst b/docs/technical_reference/costing/pressure_exchanger.rst index 6d3f1e551b..796e451685 100644 --- a/docs/technical_reference/costing/pressure_exchanger.rst +++ b/docs/technical_reference/costing/pressure_exchanger.rst @@ -1,28 +1,60 @@ Pressure Exchanger Costing Method -================================= +================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.pressure_exchanger` +* :mod:`watertap.costing.unit_models.pressure_exchanger` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/pump.rst b/docs/technical_reference/costing/pump.rst index 01f5aa3950..cce0a8296b 100644 --- a/docs/technical_reference/costing/pump.rst +++ b/docs/technical_reference/costing/pump.rst @@ -1,28 +1,60 @@ Pump Costing Method -=================== +==================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_pump` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_pump` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.pump` +* :mod:`watertap.costing.unit_models.pump` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/reverse_osmosis.rst b/docs/technical_reference/costing/reverse_osmosis.rst index ebd18bd096..5d4af661ee 100644 --- a/docs/technical_reference/costing/reverse_osmosis.rst +++ b/docs/technical_reference/costing/reverse_osmosis.rst @@ -1,28 +1,60 @@ Reverse Osmosis Costing Method -============================== +=============================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.reverse_osmosis` +* :mod:`watertap.costing.unit_models.reverse_osmosis` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/stoichiometric_reactor.rst b/docs/technical_reference/costing/stoichiometric_reactor.rst index a8645b103b..37a8001a98 100644 --- a/docs/technical_reference/costing/stoichiometric_reactor.rst +++ b/docs/technical_reference/costing/stoichiometric_reactor.rst @@ -1,28 +1,60 @@ Stoichiometric Reactor Costing Method -===================================== +====================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.stoichiometric_reactor` +* :mod:`watertap.costing.unit_models.stoichiometric_reactor` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/thickener.rst b/docs/technical_reference/costing/thickener.rst index cf35ac9a5e..7bdd6accfc 100644 --- a/docs/technical_reference/costing/thickener.rst +++ b/docs/technical_reference/costing/thickener.rst @@ -1,28 +1,60 @@ Thickener Costing Method -======================== +========================= Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_thickener` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_thickener` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.thickener` +* :mod:`watertap.costing.unit_models.thickener` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file diff --git a/docs/technical_reference/costing/uv_aop.rst b/docs/technical_reference/costing/uv_aop.rst index 8158de637c..84708c8041 100644 --- a/docs/technical_reference/costing/uv_aop.rst +++ b/docs/technical_reference/costing/uv_aop.rst @@ -1,28 +1,60 @@ UV with Advanced Oxidation Processes Costing Method -=================================================== +==================================================== Costing Method Parameters +++++++++++++++++++++++++ The following parameters are constructed when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ The following variables are constructed when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: +.. csv-table:: + :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" Capital Cost Calculations +++++++++++++++++++++++++ +Describe capital costs..keep it concise where possible + + .. math:: + + C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + + .. math:: + + & C_{cap,example1} = fill in equation for each component in total capex equation + + Operating Cost Calculations +++++++++++++++++++++++++++ +Describe operating/maintenance costs..keep it concise where possible + + .. math:: + + C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + + .. math:: + + & C_{op,example1} = fill in equation for each component in total opex equation + + Code Documentation ------------------ +* :mod:`watertap.unit_models.uv_aop` +* :mod:`watertap.costing.unit_models.uv_aop` + References ---------- +Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file From 485a2cc6c82cf2764e4c31476019e35b6c9d6311 Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Sat, 20 Apr 2024 16:03:18 -0400 Subject: [PATCH 06/15] black --- ...automate_detailed_unit_costing_rst_file.py | 41 +++++++++++++------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index 8c701d73f9..b3235857ee 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -46,7 +46,6 @@ for i, u in enumerate(unit_title_list): - # append unit doc to index with open("detailed_unit_model_costing.rst", "a") as f: f.write(f" {unit_name_list[i]}\n") @@ -71,8 +70,12 @@ f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" ) f.write(".. csv-table::\n") - f.write(' :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"\n\n') - f.write(' "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\\text{dimensionless}`"\n') + f.write( + ' :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"\n\n' + ) + f.write( + ' "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\\text{dimensionless}`"\n' + ) # TODO: add var tables f.write("\nCosting Method Variables\n") @@ -81,27 +84,39 @@ f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" ) f.write(".. csv-table::\n") - f.write(' :header: "Description", "Symbol", "Variable Name", "Default Value", "Units"\n\n') - f.write(' "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\\text{dimensionless}`"\n') + f.write( + ' :header: "Description", "Symbol", "Variable Name", "Default Value", "Units"\n\n' + ) + f.write( + ' "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\\text{dimensionless}`"\n' + ) # TODO: add capex eqs f.write("\nCapital Cost Calculations\n") f.write("+" * len("Capital Cost Calculations")) f.write("\n\nDescribe capital costs..keep it concise where possible\n\n") f.write(" .. math::\n\n") - f.write(" C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other}") + f.write( + " C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other}" + ) f.write("\n\n .. math::\n\n") - f.write(" & C_{cap,example1} = fill in equation for each component in total capex equation\n\n ") - + f.write( + " & C_{cap,example1} = fill in equation for each component in total capex equation\n\n " + ) + # TODO: add opex eqs f.write("\nOperating Cost Calculations\n") f.write("+" * len("Operating Cost Calculations")) - f.write("\n\nDescribe operating/maintenance costs..keep it concise where possible\n\n") + f.write( + "\n\nDescribe operating/maintenance costs..keep it concise where possible\n\n" + ) f.write(" .. math::\n\n") f.write(" C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other}") f.write("\n\n .. math::\n\n") - f.write(" & C_{op,example1} = fill in equation for each component in total opex equation\n\n ") - + f.write( + " & C_{op,example1} = fill in equation for each component in total opex equation\n\n " + ) + # TODO: add module directives to unit and cost method f.write("\nCode Documentation\n") f.write("-" * len("Code Documentation")) @@ -110,4 +125,6 @@ f.write("\n\nReferences\n") f.write("-" * len("References")) - f.write("\nAim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values") + f.write( + "\nAim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values" + ) From cc9cb3aada3dcb51ea0b4a4a6baa8e44ef2f616c Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Sat, 20 Apr 2024 16:19:10 -0400 Subject: [PATCH 07/15] take away ampersand --- docs/technical_reference/costing/anaerobic_digester.rst | 4 ++-- .../costing/automate_detailed_unit_costing_rst_file.py | 4 ++-- docs/technical_reference/costing/clarifier.rst | 4 ++-- docs/technical_reference/costing/compressor.rst | 4 ++-- docs/technical_reference/costing/crystallizer.rst | 4 ++-- docs/technical_reference/costing/cstr.rst | 4 ++-- docs/technical_reference/costing/cstr_injection.rst | 4 ++-- docs/technical_reference/costing/dewatering.rst | 4 ++-- docs/technical_reference/costing/electroNP.rst | 4 ++-- docs/technical_reference/costing/electrodialysis.rst | 4 ++-- docs/technical_reference/costing/electrolyzer.rst | 4 ++-- docs/technical_reference/costing/energy_recovery_device.rst | 4 ++-- docs/technical_reference/costing/evaporator.rst | 4 ++-- docs/technical_reference/costing/gac.rst | 4 ++-- docs/technical_reference/costing/heat_exchanger.rst | 4 ++-- docs/technical_reference/costing/heater_chiller.rst | 4 ++-- docs/technical_reference/costing/ion_exchange.rst | 4 ++-- docs/technical_reference/costing/membrane_distillation.rst | 4 ++-- docs/technical_reference/costing/mixer.rst | 4 ++-- docs/technical_reference/costing/nanofiltration.rst | 4 ++-- .../costing/osmotically_assisted_reverse_osmosis.rst | 4 ++-- docs/technical_reference/costing/pressure_exchanger.rst | 4 ++-- docs/technical_reference/costing/pump.rst | 4 ++-- docs/technical_reference/costing/reverse_osmosis.rst | 4 ++-- docs/technical_reference/costing/stoichiometric_reactor.rst | 4 ++-- docs/technical_reference/costing/thickener.rst | 4 ++-- docs/technical_reference/costing/uv_aop.rst | 4 ++-- 27 files changed, 54 insertions(+), 54 deletions(-) diff --git a/docs/technical_reference/costing/anaerobic_digester.rst b/docs/technical_reference/costing/anaerobic_digester.rst index 051d85a687..841d96b804 100644 --- a/docs/technical_reference/costing/anaerobic_digester.rst +++ b/docs/technical_reference/costing/anaerobic_digester.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index b3235857ee..15369ac960 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -101,7 +101,7 @@ ) f.write("\n\n .. math::\n\n") f.write( - " & C_{cap,example1} = fill in equation for each component in total capex equation\n\n " + " C_{cap,example1} = fill in equation for each component in total capex equation\n\n " ) # TODO: add opex eqs @@ -114,7 +114,7 @@ f.write(" C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other}") f.write("\n\n .. math::\n\n") f.write( - " & C_{op,example1} = fill in equation for each component in total opex equation\n\n " + " C_{op,example1} = fill in equation for each component in total opex equation\n\n " ) # TODO: add module directives to unit and cost method diff --git a/docs/technical_reference/costing/clarifier.rst b/docs/technical_reference/costing/clarifier.rst index 73ffc6ff89..2074f54a10 100644 --- a/docs/technical_reference/costing/clarifier.rst +++ b/docs/technical_reference/costing/clarifier.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/compressor.rst b/docs/technical_reference/costing/compressor.rst index e8582e4bbf..7e9cdf10c5 100644 --- a/docs/technical_reference/costing/compressor.rst +++ b/docs/technical_reference/costing/compressor.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/crystallizer.rst b/docs/technical_reference/costing/crystallizer.rst index cead5c3933..61a47043ba 100644 --- a/docs/technical_reference/costing/crystallizer.rst +++ b/docs/technical_reference/costing/crystallizer.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/cstr.rst b/docs/technical_reference/costing/cstr.rst index bd58391b1f..158d0be943 100644 --- a/docs/technical_reference/costing/cstr.rst +++ b/docs/technical_reference/costing/cstr.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/cstr_injection.rst b/docs/technical_reference/costing/cstr_injection.rst index 3e8fa8e1ac..3b336ec454 100644 --- a/docs/technical_reference/costing/cstr_injection.rst +++ b/docs/technical_reference/costing/cstr_injection.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/dewatering.rst b/docs/technical_reference/costing/dewatering.rst index 8cbeb30814..c988a13ce2 100644 --- a/docs/technical_reference/costing/dewatering.rst +++ b/docs/technical_reference/costing/dewatering.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/electroNP.rst b/docs/technical_reference/costing/electroNP.rst index d6e87dd29a..f31c3205a7 100644 --- a/docs/technical_reference/costing/electroNP.rst +++ b/docs/technical_reference/costing/electroNP.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/electrodialysis.rst b/docs/technical_reference/costing/electrodialysis.rst index 9be1dbbf64..12fa5ba929 100644 --- a/docs/technical_reference/costing/electrodialysis.rst +++ b/docs/technical_reference/costing/electrodialysis.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/electrolyzer.rst b/docs/technical_reference/costing/electrolyzer.rst index 198cb67db6..9a3497037d 100644 --- a/docs/technical_reference/costing/electrolyzer.rst +++ b/docs/technical_reference/costing/electrolyzer.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/energy_recovery_device.rst b/docs/technical_reference/costing/energy_recovery_device.rst index 9a133a4d13..7c4f1f8879 100644 --- a/docs/technical_reference/costing/energy_recovery_device.rst +++ b/docs/technical_reference/costing/energy_recovery_device.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/evaporator.rst b/docs/technical_reference/costing/evaporator.rst index 6cdb5862a9..2b32b98224 100644 --- a/docs/technical_reference/costing/evaporator.rst +++ b/docs/technical_reference/costing/evaporator.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/gac.rst b/docs/technical_reference/costing/gac.rst index f43871e537..9c661531d5 100644 --- a/docs/technical_reference/costing/gac.rst +++ b/docs/technical_reference/costing/gac.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/heat_exchanger.rst b/docs/technical_reference/costing/heat_exchanger.rst index b647293c77..cd150989c4 100644 --- a/docs/technical_reference/costing/heat_exchanger.rst +++ b/docs/technical_reference/costing/heat_exchanger.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/heater_chiller.rst b/docs/technical_reference/costing/heater_chiller.rst index 5d38b05762..1c42fa6590 100644 --- a/docs/technical_reference/costing/heater_chiller.rst +++ b/docs/technical_reference/costing/heater_chiller.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/ion_exchange.rst b/docs/technical_reference/costing/ion_exchange.rst index c7b2589b15..b0da26c0c3 100644 --- a/docs/technical_reference/costing/ion_exchange.rst +++ b/docs/technical_reference/costing/ion_exchange.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/membrane_distillation.rst b/docs/technical_reference/costing/membrane_distillation.rst index c9474a1835..c1313f27ba 100644 --- a/docs/technical_reference/costing/membrane_distillation.rst +++ b/docs/technical_reference/costing/membrane_distillation.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/mixer.rst b/docs/technical_reference/costing/mixer.rst index 7886aa548f..b59e8da4b0 100644 --- a/docs/technical_reference/costing/mixer.rst +++ b/docs/technical_reference/costing/mixer.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/nanofiltration.rst b/docs/technical_reference/costing/nanofiltration.rst index d8a0313155..53b45a86de 100644 --- a/docs/technical_reference/costing/nanofiltration.rst +++ b/docs/technical_reference/costing/nanofiltration.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst index 16303e3d64..e7b70f3f4b 100644 --- a/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst +++ b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/pressure_exchanger.rst b/docs/technical_reference/costing/pressure_exchanger.rst index 796e451685..8b06dbb332 100644 --- a/docs/technical_reference/costing/pressure_exchanger.rst +++ b/docs/technical_reference/costing/pressure_exchanger.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/pump.rst b/docs/technical_reference/costing/pump.rst index cce0a8296b..3a8ea1da75 100644 --- a/docs/technical_reference/costing/pump.rst +++ b/docs/technical_reference/costing/pump.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/reverse_osmosis.rst b/docs/technical_reference/costing/reverse_osmosis.rst index 5d4af661ee..12056c951a 100644 --- a/docs/technical_reference/costing/reverse_osmosis.rst +++ b/docs/technical_reference/costing/reverse_osmosis.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/stoichiometric_reactor.rst b/docs/technical_reference/costing/stoichiometric_reactor.rst index 37a8001a98..0b3dfecabd 100644 --- a/docs/technical_reference/costing/stoichiometric_reactor.rst +++ b/docs/technical_reference/costing/stoichiometric_reactor.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/thickener.rst b/docs/technical_reference/costing/thickener.rst index 7bdd6accfc..7512b03757 100644 --- a/docs/technical_reference/costing/thickener.rst +++ b/docs/technical_reference/costing/thickener.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation diff --git a/docs/technical_reference/costing/uv_aop.rst b/docs/technical_reference/costing/uv_aop.rst index 84708c8041..00726bb9ed 100644 --- a/docs/technical_reference/costing/uv_aop.rst +++ b/docs/technical_reference/costing/uv_aop.rst @@ -32,7 +32,7 @@ Describe capital costs..keep it concise where possible .. math:: - & C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,example1} = fill in equation for each component in total capex equation Operating Cost Calculations @@ -46,7 +46,7 @@ Describe operating/maintenance costs..keep it concise where possible .. math:: - & C_{op,example1} = fill in equation for each component in total opex equation + C_{op,example1} = fill in equation for each component in total opex equation Code Documentation From b16235cb039610c30be9fd11b2c2e9986cca92d1 Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Mon, 22 Apr 2024 14:46:00 -0400 Subject: [PATCH 08/15] added overwrite and overwrite list options --- ...automate_detailed_unit_costing_rst_file.py | 242 +++++++++++------- 1 file changed, 147 insertions(+), 95 deletions(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index 15369ac960..b54ec5b126 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -18,7 +18,7 @@ unit_title_list = [i.title() for i in df["name"]] -unit_name_list = df["unit"] +unit_name_list = list(df["unit"]) title_exceptions = { "cstr_injection": "Completely Stirred Tank Reactor w/Injection Stream", @@ -32,99 +32,151 @@ if __name__ == "__main__": - - # Create index file for all unit model costing docs - with open("detailed_unit_model_costing.rst", "w") as f: - f.write("Detailed Unit Model Costing\n") - f.write("=" * len("Detailed Unit Model Costing")) - f.write("\n") - f.write( - "Default costing methods are provided for the unit models listed below. However, users should supply their own cost relationship, if possible, instead of relying completely on the defaults.\n\n" - ) - f.write(".. toctree::\n") - f.write(" :maxdepth: 1\n\n") - - for i, u in enumerate(unit_title_list): - - # append unit doc to index - with open("detailed_unit_model_costing.rst", "a") as f: - f.write(f" {unit_name_list[i]}\n") - - with open(f"{unit_name_list[i]}.rst", "w", encoding="utf-8") as f: - # write doc title based on unit name - if unit_name_list[i] in title_exceptions: - f.write(f"{title_exceptions[unit_name_list[i]]} Costing Method") - f.write("\n") - f.write( - "=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method\n") - ) - else: - f.write(f"{unit_title_list[i]} Costing Method") - f.write("\n") - f.write("=" * len(f"{unit_title_list[i]} Costing Method\n")) - - # TODO: add parameter tables - f.write("\n\nCosting Method Parameters\n") - f.write("+" * len("Costing Method Parameters")) - f.write( - f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" - ) - f.write(".. csv-table::\n") - f.write( - ' :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"\n\n' - ) - f.write( - ' "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\\text{dimensionless}`"\n' - ) - - # TODO: add var tables - f.write("\nCosting Method Variables\n") - f.write("+" * len("Costing Method Variables")) - f.write( - f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" - ) - f.write(".. csv-table::\n") - f.write( - ' :header: "Description", "Symbol", "Variable Name", "Default Value", "Units"\n\n' - ) - f.write( - ' "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\\text{dimensionless}`"\n' - ) - - # TODO: add capex eqs - f.write("\nCapital Cost Calculations\n") - f.write("+" * len("Capital Cost Calculations")) - f.write("\n\nDescribe capital costs..keep it concise where possible\n\n") - f.write(" .. math::\n\n") - f.write( - " C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other}" - ) - f.write("\n\n .. math::\n\n") + # Toggle OVERWRITE to True to overwrite unit model costing rst files + OVERWRITE = True + # Specify unit model costing filenames (e.g., "ion_exchange") that you want to overwrite + # Otherwise, if list left empty, the default is to overwrite all files + OVERWRITE_LIST = [] + try: + with open("detailed_unit_model_costing.rst", "r") as f: + lines = f.readlines() + except: + + # Create index file for all unit model costing docs + with open("detailed_unit_model_costing.rst", "w") as f: + f.write("Detailed Unit Model Costing\n") + f.write("=" * len("Detailed Unit Model Costing")) + f.write("\n") f.write( - " C_{cap,example1} = fill in equation for each component in total capex equation\n\n " - ) - - # TODO: add opex eqs - f.write("\nOperating Cost Calculations\n") - f.write("+" * len("Operating Cost Calculations")) - f.write( - "\n\nDescribe operating/maintenance costs..keep it concise where possible\n\n" - ) - f.write(" .. math::\n\n") - f.write(" C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other}") - f.write("\n\n .. math::\n\n") - f.write( - " C_{op,example1} = fill in equation for each component in total opex equation\n\n " - ) - - # TODO: add module directives to unit and cost method - f.write("\nCode Documentation\n") - f.write("-" * len("Code Documentation")) - f.write(f"\n\n* :mod:`watertap.unit_models.{unit_name_list[i]}`") - f.write(f"\n* :mod:`watertap.costing.unit_models.{unit_name_list[i]}`") - - f.write("\n\nReferences\n") - f.write("-" * len("References")) - f.write( - "\nAim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values" + "Default costing methods are provided for the unit models listed below. However, users should supply their own cost relationship, if possible, instead of relying completely on the defaults.\n\n" ) + f.write(".. toctree::\n") + f.write(" :maxdepth: 1\n\n") + with open("detailed_unit_model_costing.rst", "r") as f: + lines = f.readlines() + + # count_on_list= 0 + # count_not_on_list=0 + for i, unit_title in enumerate(unit_title_list): + for l, line in enumerate(lines): + # set on_list flag to False in unit name not found in landing page list + if (unit_name_list[i] != line.strip()): + on_list=False + # set on_list flag to True if unit name is on landing page list and break inner loop + else: + on_list=True + line_index=l + break + # if on_list: + # print("inner loop BROKEN") + + # count_on_list=count_on_list+1 + + # else: + # count_not_on_list=count_not_on_list+1 + + + # if new entry or if overwriting existing entry + if (not on_list) or (OVERWRITE and (on_list)): + + # check that entries in OVERWRITE_LIST are valid + if OVERWRITE and len(OVERWRITE_LIST): + if all(overwrite_item not in unit_name_list for overwrite_item in OVERWRITE_LIST): + raise ValueError("Entries provided in OVERWRITE_LIST are invalid.\nOVERWRITE_LIST should be empty or contain a list of valid unit names (e.g., 'ion_exchange')") + + # if this is a new entry, append the unit name to the landing page for all unit costing + if not on_list: + # append unit doc to index + with open("detailed_unit_model_costing.rst", "a") as f: + f.write(f" {unit_name_list[i]}\n") + else: + # either overwrite all units in the landing page OR overwrite specific units specified on OVERWRITE_LIST + if (not len(OVERWRITE_LIST)) or (any(item==unit_name_list[i] for item in OVERWRITE_LIST)): + lines[line_index] = f" {unit_name_list[i]}\n" + with open("detailed_unit_model_costing.rst", "w") as f: + f.writelines(lines) + else: + pass + + if (not on_list) or (not len(OVERWRITE_LIST)) or (any(item==unit_name_list[i] for item in OVERWRITE_LIST)): + with open(f"{unit_name_list[i]}.rst", "w") as f: + + # write doc title based on unit name + if unit_name_list[i] in title_exceptions: + f.write(f"{title_exceptions[unit_name_list[i]]} Costing Method") + f.write("\n") + f.write( + "=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method\n") + ) + else: + f.write(f"{unit_title} Costing Method") + f.write("\n") + f.write("=" * len(f"{unit_title} Costing Method\n")) + + # TODO: add parameter tables + f.write("\n\nCosting Method Parameters\n") + f.write("+" * len("Costing Method Parameters")) + f.write( + f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" + ) + f.write(".. csv-table::\n") + f.write( + ' :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units"\n\n' + ) + f.write( + ' "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\\text{dimensionless}`"\n' + ) + + # TODO: add var tables + f.write("\nCosting Method Variables\n") + f.write("+" * len("Costing Method Variables")) + f.write( + f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" + ) + f.write(".. csv-table::\n") + f.write( + ' :header: "Description", "Symbol", "Variable Name", "Default Value", "Units"\n\n' + ) + f.write( + ' "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\\text{dimensionless}`"\n' + ) + + # TODO: add capex eqs + f.write("\nCapital Cost Calculations\n") + f.write("+" * len("Capital Cost Calculations")) + f.write("\n\nDescribe capital costs..keep it concise where possible\n\n") + f.write(" .. math::\n\n") + f.write( + " C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other}" + ) + f.write("\n\n .. math::\n\n") + f.write( + " C_{cap,example1} = fill in equation for each component in total capex equation\n\n " + ) + + # TODO: add opex eqs + f.write("\nOperating Cost Calculations\n") + f.write("+" * len("Operating Cost Calculations")) + f.write( + "\n\nDescribe operating/maintenance costs..keep it concise where possible\n\n" + ) + f.write(" .. math::\n\n") + f.write(" C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other}") + f.write("\n\n .. math::\n\n") + f.write( + " C_{op,example1} = fill in equation for each component in total opex equation\n\n " + ) + + # TODO: add module directives to unit and cost method + f.write("\nCode Documentation\n") + f.write("-" * len("Code Documentation")) + f.write(f"\n\n* :mod:`watertap.unit_models.{unit_name_list[i]}`") + f.write(f"\n* :mod:`watertap.costing.unit_models.{unit_name_list[i]}`") + + f.write("\n\nReferences\n") + f.write("-" * len("References")) + f.write( + "\nAim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values" + ) + # print("number on the list=", count_on_list) + # print("number not on the list=", count_not_on_list) \ No newline at end of file From 017706e12a70a62337e596e6d64f536ba627cce6 Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Mon, 22 Apr 2024 14:59:50 -0400 Subject: [PATCH 09/15] delete comments --- .../automate_detailed_unit_costing_rst_file.py | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index b54ec5b126..e4722fa8e9 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -16,6 +16,7 @@ df = pd.read_csv("WT_unit_costing_for_docs.csv") + unit_title_list = [i.title() for i in df["name"]] unit_name_list = list(df["unit"]) @@ -55,8 +56,7 @@ with open("detailed_unit_model_costing.rst", "r") as f: lines = f.readlines() - # count_on_list= 0 - # count_not_on_list=0 + for i, unit_title in enumerate(unit_title_list): for l, line in enumerate(lines): # set on_list flag to False in unit name not found in landing page list @@ -67,14 +67,6 @@ on_list=True line_index=l break - # if on_list: - # print("inner loop BROKEN") - - # count_on_list=count_on_list+1 - - # else: - # count_not_on_list=count_not_on_list+1 - # if new entry or if overwriting existing entry if (not on_list) or (OVERWRITE and (on_list)): @@ -178,5 +170,3 @@ f.write( "\nAim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values" ) - # print("number on the list=", count_on_list) - # print("number not on the list=", count_not_on_list) \ No newline at end of file From f7ead457a87caca4f1a177ea6bbb131f47b9b1ee Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Mon, 22 Apr 2024 17:44:42 -0400 Subject: [PATCH 10/15] black --- ...automate_detailed_unit_costing_rst_file.py | 53 +++++++++++++------ 1 file changed, 36 insertions(+), 17 deletions(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index e4722fa8e9..64db6b11d9 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -41,7 +41,7 @@ try: with open("detailed_unit_model_costing.rst", "r") as f: lines = f.readlines() - except: + except: # Create index file for all unit model costing docs with open("detailed_unit_model_costing.rst", "w") as f: @@ -56,25 +56,29 @@ with open("detailed_unit_model_costing.rst", "r") as f: lines = f.readlines() - for i, unit_title in enumerate(unit_title_list): for l, line in enumerate(lines): # set on_list flag to False in unit name not found in landing page list - if (unit_name_list[i] != line.strip()): - on_list=False + if unit_name_list[i] != line.strip(): + on_list = False # set on_list flag to True if unit name is on landing page list and break inner loop else: - on_list=True - line_index=l + on_list = True + line_index = l break # if new entry or if overwriting existing entry - if (not on_list) or (OVERWRITE and (on_list)): - + if (not on_list) or (OVERWRITE and (on_list)): + # check that entries in OVERWRITE_LIST are valid if OVERWRITE and len(OVERWRITE_LIST): - if all(overwrite_item not in unit_name_list for overwrite_item in OVERWRITE_LIST): - raise ValueError("Entries provided in OVERWRITE_LIST are invalid.\nOVERWRITE_LIST should be empty or contain a list of valid unit names (e.g., 'ion_exchange')") + if all( + overwrite_item not in unit_name_list + for overwrite_item in OVERWRITE_LIST + ): + raise ValueError( + "Entries provided in OVERWRITE_LIST are invalid.\nOVERWRITE_LIST should be empty or contain a list of valid unit names (e.g., 'ion_exchange')" + ) # if this is a new entry, append the unit name to the landing page for all unit costing if not on_list: @@ -83,14 +87,20 @@ f.write(f" {unit_name_list[i]}\n") else: # either overwrite all units in the landing page OR overwrite specific units specified on OVERWRITE_LIST - if (not len(OVERWRITE_LIST)) or (any(item==unit_name_list[i] for item in OVERWRITE_LIST)): + if (not len(OVERWRITE_LIST)) or ( + any(item == unit_name_list[i] for item in OVERWRITE_LIST) + ): lines[line_index] = f" {unit_name_list[i]}\n" with open("detailed_unit_model_costing.rst", "w") as f: f.writelines(lines) else: pass - - if (not on_list) or (not len(OVERWRITE_LIST)) or (any(item==unit_name_list[i] for item in OVERWRITE_LIST)): + + if ( + (not on_list) + or (not len(OVERWRITE_LIST)) + or (any(item == unit_name_list[i] for item in OVERWRITE_LIST)) + ): with open(f"{unit_name_list[i]}.rst", "w") as f: # write doc title based on unit name @@ -98,7 +108,10 @@ f.write(f"{title_exceptions[unit_name_list[i]]} Costing Method") f.write("\n") f.write( - "=" * len(f"{title_exceptions[unit_name_list[i]]} Costing Method\n") + "=" + * len( + f"{title_exceptions[unit_name_list[i]]} Costing Method\n" + ) ) else: f.write(f"{unit_title} Costing Method") @@ -136,7 +149,9 @@ # TODO: add capex eqs f.write("\nCapital Cost Calculations\n") f.write("+" * len("Capital Cost Calculations")) - f.write("\n\nDescribe capital costs..keep it concise where possible\n\n") + f.write( + "\n\nDescribe capital costs..keep it concise where possible\n\n" + ) f.write(" .. math::\n\n") f.write( " C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other}" @@ -153,7 +168,9 @@ "\n\nDescribe operating/maintenance costs..keep it concise where possible\n\n" ) f.write(" .. math::\n\n") - f.write(" C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other}") + f.write( + " C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other}" + ) f.write("\n\n .. math::\n\n") f.write( " C_{op,example1} = fill in equation for each component in total opex equation\n\n " @@ -163,7 +180,9 @@ f.write("\nCode Documentation\n") f.write("-" * len("Code Documentation")) f.write(f"\n\n* :mod:`watertap.unit_models.{unit_name_list[i]}`") - f.write(f"\n* :mod:`watertap.costing.unit_models.{unit_name_list[i]}`") + f.write( + f"\n* :mod:`watertap.costing.unit_models.{unit_name_list[i]}`" + ) f.write("\n\nReferences\n") f.write("-" * len("References")) From bfc129631cedc6717e64f49d6effc57866fd164d Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Mon, 22 Apr 2024 17:45:38 -0400 Subject: [PATCH 11/15] change overwrite default to false so people don't erase their changes unintentionally --- .../costing/automate_detailed_unit_costing_rst_file.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index 64db6b11d9..1daf09465b 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -34,7 +34,7 @@ if __name__ == "__main__": # Toggle OVERWRITE to True to overwrite unit model costing rst files - OVERWRITE = True + OVERWRITE = False # Specify unit model costing filenames (e.g., "ion_exchange") that you want to overwrite # Otherwise, if list left empty, the default is to overwrite all files OVERWRITE_LIST = [] From fe183b2aef0f4237056ef4906a97ddf9c771dae9 Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Tue, 23 Apr 2024 14:58:06 -0400 Subject: [PATCH 12/15] Update docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py Co-authored-by: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com> --- .../costing/automate_detailed_unit_costing_rst_file.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index 1daf09465b..e39f63db19 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -58,7 +58,7 @@ for i, unit_title in enumerate(unit_title_list): for l, line in enumerate(lines): - # set on_list flag to False in unit name not found in landing page list + # set on_list flag to False if unit name not found in landing page list if unit_name_list[i] != line.strip(): on_list = False # set on_list flag to True if unit name is on landing page list and break inner loop From 46e2afaba3106c9229fb5c38b2dc3ed6909bab9a Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Thu, 25 Apr 2024 17:40:09 -0400 Subject: [PATCH 13/15] delete ref to unit model code --- .../costing/automate_detailed_unit_costing_rst_file.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index 1daf09465b..8db9e8443e 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -34,7 +34,7 @@ if __name__ == "__main__": # Toggle OVERWRITE to True to overwrite unit model costing rst files - OVERWRITE = False + OVERWRITE = True # Specify unit model costing filenames (e.g., "ion_exchange") that you want to overwrite # Otherwise, if list left empty, the default is to overwrite all files OVERWRITE_LIST = [] @@ -179,9 +179,8 @@ # TODO: add module directives to unit and cost method f.write("\nCode Documentation\n") f.write("-" * len("Code Documentation")) - f.write(f"\n\n* :mod:`watertap.unit_models.{unit_name_list[i]}`") f.write( - f"\n* :mod:`watertap.costing.unit_models.{unit_name_list[i]}`" + f"\n\n* :mod:`watertap.costing.unit_models.{unit_name_list[i]}`" ) f.write("\n\nReferences\n") From 951f1ed7c559378ebd67cb0901a0372977d65ee5 Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Thu, 25 Apr 2024 17:55:18 -0400 Subject: [PATCH 14/15] specify where cost parameters live and where unit cost vars live --- docs/technical_reference/costing/anaerobic_digester.rst | 5 ++--- .../costing/automate_detailed_unit_costing_rst_file.py | 4 ++-- docs/technical_reference/costing/clarifier.rst | 5 ++--- docs/technical_reference/costing/compressor.rst | 5 ++--- docs/technical_reference/costing/crystallizer.rst | 5 ++--- docs/technical_reference/costing/cstr.rst | 5 ++--- docs/technical_reference/costing/cstr_injection.rst | 5 ++--- docs/technical_reference/costing/dewatering.rst | 5 ++--- docs/technical_reference/costing/electroNP.rst | 5 ++--- docs/technical_reference/costing/electrodialysis.rst | 5 ++--- docs/technical_reference/costing/electrolyzer.rst | 5 ++--- docs/technical_reference/costing/energy_recovery_device.rst | 5 ++--- docs/technical_reference/costing/evaporator.rst | 5 ++--- docs/technical_reference/costing/gac.rst | 5 ++--- docs/technical_reference/costing/heat_exchanger.rst | 5 ++--- docs/technical_reference/costing/heater_chiller.rst | 5 ++--- docs/technical_reference/costing/ion_exchange.rst | 5 ++--- docs/technical_reference/costing/membrane_distillation.rst | 5 ++--- docs/technical_reference/costing/mixer.rst | 5 ++--- docs/technical_reference/costing/nanofiltration.rst | 5 ++--- .../costing/osmotically_assisted_reverse_osmosis.rst | 5 ++--- docs/technical_reference/costing/pressure_exchanger.rst | 5 ++--- docs/technical_reference/costing/pump.rst | 5 ++--- docs/technical_reference/costing/reverse_osmosis.rst | 5 ++--- docs/technical_reference/costing/stoichiometric_reactor.rst | 5 ++--- docs/technical_reference/costing/thickener.rst | 5 ++--- docs/technical_reference/costing/uv_aop.rst | 5 ++--- 27 files changed, 54 insertions(+), 80 deletions(-) diff --git a/docs/technical_reference/costing/anaerobic_digester.rst b/docs/technical_reference/costing/anaerobic_digester.rst index 841d96b804..98cfb9d5a8 100644 --- a/docs/technical_reference/costing/anaerobic_digester.rst +++ b/docs/technical_reference/costing/anaerobic_digester.rst @@ -4,7 +4,7 @@ Anaerobic Digester Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.anaerobic_digester`) when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_anaerobic_diges Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_anaerobic_digester` costing method in the ``watertap_costing_package``: +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" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.anaerobic_digester` * :mod:`watertap.costing.unit_models.anaerobic_digester` References diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index 8db9e8443e..1b82c2c79a 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -122,7 +122,7 @@ f.write("\n\nCosting Method Parameters\n") f.write("+" * len("Costing Method Parameters")) f.write( - f"\n\nThe following parameters are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" + f"\n\nThe following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.{unit_name_list[i]}`) when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" ) f.write(".. csv-table::\n") f.write( @@ -136,7 +136,7 @@ f.write("\nCosting Method Variables\n") f.write("+" * len("Costing Method Variables")) f.write( - f"\n\nThe following variables are constructed when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" + f"\n\nThe following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_{unit_name_list[i]}` costing method in the ``watertap_costing_package``:\n\n" ) f.write(".. csv-table::\n") f.write( diff --git a/docs/technical_reference/costing/clarifier.rst b/docs/technical_reference/costing/clarifier.rst index 2074f54a10..ff3cb35510 100644 --- a/docs/technical_reference/costing/clarifier.rst +++ b/docs/technical_reference/costing/clarifier.rst @@ -4,7 +4,7 @@ Clarifier Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.clarifier`) when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_clarifier` cost Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.clarifier` * :mod:`watertap.costing.unit_models.clarifier` References diff --git a/docs/technical_reference/costing/compressor.rst b/docs/technical_reference/costing/compressor.rst index 7e9cdf10c5..4a03ef47cc 100644 --- a/docs/technical_reference/costing/compressor.rst +++ b/docs/technical_reference/costing/compressor.rst @@ -4,7 +4,7 @@ Compressor Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_compressor` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.compressor`) when applying the `cost_compressor` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_compressor` cos Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_compressor` costing method in the ``watertap_costing_package``: +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" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.compressor` * :mod:`watertap.costing.unit_models.compressor` References diff --git a/docs/technical_reference/costing/crystallizer.rst b/docs/technical_reference/costing/crystallizer.rst index 61a47043ba..44d6986d55 100644 --- a/docs/technical_reference/costing/crystallizer.rst +++ b/docs/technical_reference/costing/crystallizer.rst @@ -4,7 +4,7 @@ Crystallizer Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.crystallizer`) when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_crystallizer` c Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_crystallizer` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.crystallizer` * :mod:`watertap.costing.unit_models.crystallizer` References diff --git a/docs/technical_reference/costing/cstr.rst b/docs/technical_reference/costing/cstr.rst index 158d0be943..e78bc4845e 100644 --- a/docs/technical_reference/costing/cstr.rst +++ b/docs/technical_reference/costing/cstr.rst @@ -4,7 +4,7 @@ Completely Stirred Tank Reactor Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_cstr` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.cstr`) when applying the `cost_cstr` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_cstr` costing m Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_cstr` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_cstr` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.cstr` * :mod:`watertap.costing.unit_models.cstr` References diff --git a/docs/technical_reference/costing/cstr_injection.rst b/docs/technical_reference/costing/cstr_injection.rst index 3b336ec454..e8d9b6da61 100644 --- a/docs/technical_reference/costing/cstr_injection.rst +++ b/docs/technical_reference/costing/cstr_injection.rst @@ -4,7 +4,7 @@ Completely Stirred Tank Reactor w/Injection Stream Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.cstr_injection`) when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_cstr_injection` Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.cstr_injection` * :mod:`watertap.costing.unit_models.cstr_injection` References diff --git a/docs/technical_reference/costing/dewatering.rst b/docs/technical_reference/costing/dewatering.rst index c988a13ce2..7dc8dac571 100644 --- a/docs/technical_reference/costing/dewatering.rst +++ b/docs/technical_reference/costing/dewatering.rst @@ -4,7 +4,7 @@ Dewatering Unit Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.dewatering`) when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_dewatering` cos Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.dewatering` * :mod:`watertap.costing.unit_models.dewatering` References diff --git a/docs/technical_reference/costing/electroNP.rst b/docs/technical_reference/costing/electroNP.rst index f31c3205a7..4a2fbfe0a1 100644 --- a/docs/technical_reference/costing/electroNP.rst +++ b/docs/technical_reference/costing/electroNP.rst @@ -4,7 +4,7 @@ ElectroN-P Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.electroNP`) when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_electroNP` cost Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_electroNP` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.electroNP` * :mod:`watertap.costing.unit_models.electroNP` References diff --git a/docs/technical_reference/costing/electrodialysis.rst b/docs/technical_reference/costing/electrodialysis.rst index 12fa5ba929..81270aaba2 100644 --- a/docs/technical_reference/costing/electrodialysis.rst +++ b/docs/technical_reference/costing/electrodialysis.rst @@ -4,7 +4,7 @@ Electrodialysis Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.electrodialysis`) when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_electrodialysis Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_electrodialysis` costing method in the ``watertap_costing_package``: +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" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.electrodialysis` * :mod:`watertap.costing.unit_models.electrodialysis` References diff --git a/docs/technical_reference/costing/electrolyzer.rst b/docs/technical_reference/costing/electrolyzer.rst index 9a3497037d..295defac99 100644 --- a/docs/technical_reference/costing/electrolyzer.rst +++ b/docs/technical_reference/costing/electrolyzer.rst @@ -4,7 +4,7 @@ Electrolyzer Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.electrolyzer`) when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_electrolyzer` c Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_electrolyzer` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.electrolyzer` * :mod:`watertap.costing.unit_models.electrolyzer` References diff --git a/docs/technical_reference/costing/energy_recovery_device.rst b/docs/technical_reference/costing/energy_recovery_device.rst index 7c4f1f8879..1e611b6e59 100644 --- a/docs/technical_reference/costing/energy_recovery_device.rst +++ b/docs/technical_reference/costing/energy_recovery_device.rst @@ -4,7 +4,7 @@ Energy Recovery Device Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.energy_recovery_device`) when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_energy_recovery Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_energy_recovery_device` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.energy_recovery_device` * :mod:`watertap.costing.unit_models.energy_recovery_device` References diff --git a/docs/technical_reference/costing/evaporator.rst b/docs/technical_reference/costing/evaporator.rst index 2b32b98224..183ecc2b52 100644 --- a/docs/technical_reference/costing/evaporator.rst +++ b/docs/technical_reference/costing/evaporator.rst @@ -4,7 +4,7 @@ Evaporator Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.evaporator`) when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_evaporator` cos Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_evaporator` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.evaporator` * :mod:`watertap.costing.unit_models.evaporator` References diff --git a/docs/technical_reference/costing/gac.rst b/docs/technical_reference/costing/gac.rst index 9c661531d5..44105bb801 100644 --- a/docs/technical_reference/costing/gac.rst +++ b/docs/technical_reference/costing/gac.rst @@ -4,7 +4,7 @@ Granular Activated Carbon Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_gac` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.gac`) when applying the `cost_gac` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_gac` costing me Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_gac` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_gac` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.gac` * :mod:`watertap.costing.unit_models.gac` References diff --git a/docs/technical_reference/costing/heat_exchanger.rst b/docs/technical_reference/costing/heat_exchanger.rst index cd150989c4..916c12d353 100644 --- a/docs/technical_reference/costing/heat_exchanger.rst +++ b/docs/technical_reference/costing/heat_exchanger.rst @@ -4,7 +4,7 @@ Heat Exchanger Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.heat_exchanger`) when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_heat_exchanger` Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_heat_exchanger` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.heat_exchanger` * :mod:`watertap.costing.unit_models.heat_exchanger` References diff --git a/docs/technical_reference/costing/heater_chiller.rst b/docs/technical_reference/costing/heater_chiller.rst index 1c42fa6590..752646c5d9 100644 --- a/docs/technical_reference/costing/heater_chiller.rst +++ b/docs/technical_reference/costing/heater_chiller.rst @@ -4,7 +4,7 @@ Heater/Chiller Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.heater_chiller`) when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_heater_chiller` Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_heater_chiller` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.heater_chiller` * :mod:`watertap.costing.unit_models.heater_chiller` References diff --git a/docs/technical_reference/costing/ion_exchange.rst b/docs/technical_reference/costing/ion_exchange.rst index b0da26c0c3..cf51c6322c 100644 --- a/docs/technical_reference/costing/ion_exchange.rst +++ b/docs/technical_reference/costing/ion_exchange.rst @@ -4,7 +4,7 @@ Ion Exchange Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.ion_exchange`) when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_ion_exchange` c Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_ion_exchange` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.ion_exchange` * :mod:`watertap.costing.unit_models.ion_exchange` References diff --git a/docs/technical_reference/costing/membrane_distillation.rst b/docs/technical_reference/costing/membrane_distillation.rst index c1313f27ba..2d28149d67 100644 --- a/docs/technical_reference/costing/membrane_distillation.rst +++ b/docs/technical_reference/costing/membrane_distillation.rst @@ -4,7 +4,7 @@ Membrane Distillation Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.membrane_distillation`) when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_membrane_distil Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_membrane_distillation` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.membrane_distillation` * :mod:`watertap.costing.unit_models.membrane_distillation` References diff --git a/docs/technical_reference/costing/mixer.rst b/docs/technical_reference/costing/mixer.rst index b59e8da4b0..73dff5e483 100644 --- a/docs/technical_reference/costing/mixer.rst +++ b/docs/technical_reference/costing/mixer.rst @@ -4,7 +4,7 @@ Mixer Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_mixer` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.mixer`) when applying the `cost_mixer` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_mixer` costing Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_mixer` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_mixer` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.mixer` * :mod:`watertap.costing.unit_models.mixer` References diff --git a/docs/technical_reference/costing/nanofiltration.rst b/docs/technical_reference/costing/nanofiltration.rst index 53b45a86de..3128aac287 100644 --- a/docs/technical_reference/costing/nanofiltration.rst +++ b/docs/technical_reference/costing/nanofiltration.rst @@ -4,7 +4,7 @@ Nanofiltration Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.nanofiltration`) when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_nanofiltration` Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_nanofiltration` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.nanofiltration` * :mod:`watertap.costing.unit_models.nanofiltration` References diff --git a/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst index e7b70f3f4b..ec5308f5e5 100644 --- a/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst +++ b/docs/technical_reference/costing/osmotically_assisted_reverse_osmosis.rst @@ -4,7 +4,7 @@ Osmotically Assisted Reverse Osmosis Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.osmotically_assisted_reverse_osmosis`) when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_osmotically_ass Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_osmotically_assisted_reverse_osmosis` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.osmotically_assisted_reverse_osmosis` * :mod:`watertap.costing.unit_models.osmotically_assisted_reverse_osmosis` References diff --git a/docs/technical_reference/costing/pressure_exchanger.rst b/docs/technical_reference/costing/pressure_exchanger.rst index 8b06dbb332..59f4c463e4 100644 --- a/docs/technical_reference/costing/pressure_exchanger.rst +++ b/docs/technical_reference/costing/pressure_exchanger.rst @@ -4,7 +4,7 @@ Pressure Exchanger Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.pressure_exchanger`) when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_pressure_exchan Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_pressure_exchanger` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.pressure_exchanger` * :mod:`watertap.costing.unit_models.pressure_exchanger` References diff --git a/docs/technical_reference/costing/pump.rst b/docs/technical_reference/costing/pump.rst index 3a8ea1da75..86632dbb06 100644 --- a/docs/technical_reference/costing/pump.rst +++ b/docs/technical_reference/costing/pump.rst @@ -4,7 +4,7 @@ Pump Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_pump` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.pump`) when applying the `cost_pump` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_pump` costing m Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_pump` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_pump` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.pump` * :mod:`watertap.costing.unit_models.pump` References diff --git a/docs/technical_reference/costing/reverse_osmosis.rst b/docs/technical_reference/costing/reverse_osmosis.rst index 12056c951a..022b68b9c1 100644 --- a/docs/technical_reference/costing/reverse_osmosis.rst +++ b/docs/technical_reference/costing/reverse_osmosis.rst @@ -4,7 +4,7 @@ Reverse Osmosis Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.reverse_osmosis`) when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_reverse_osmosis Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_reverse_osmosis` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.reverse_osmosis` * :mod:`watertap.costing.unit_models.reverse_osmosis` References diff --git a/docs/technical_reference/costing/stoichiometric_reactor.rst b/docs/technical_reference/costing/stoichiometric_reactor.rst index 0b3dfecabd..46c33f2ff4 100644 --- a/docs/technical_reference/costing/stoichiometric_reactor.rst +++ b/docs/technical_reference/costing/stoichiometric_reactor.rst @@ -4,7 +4,7 @@ Stoichiometric Reactor Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.stoichiometric_reactor`) when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_stoichiometric_ Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_stoichiometric_reactor` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.stoichiometric_reactor` * :mod:`watertap.costing.unit_models.stoichiometric_reactor` References diff --git a/docs/technical_reference/costing/thickener.rst b/docs/technical_reference/costing/thickener.rst index 7512b03757..1beb331f74 100644 --- a/docs/technical_reference/costing/thickener.rst +++ b/docs/technical_reference/costing/thickener.rst @@ -4,7 +4,7 @@ Thickener Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_thickener` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.thickener`) when applying the `cost_thickener` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_thickener` cost Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_thickener` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_thickener` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.thickener` * :mod:`watertap.costing.unit_models.thickener` References diff --git a/docs/technical_reference/costing/uv_aop.rst b/docs/technical_reference/costing/uv_aop.rst index 00726bb9ed..77775a7503 100644 --- a/docs/technical_reference/costing/uv_aop.rst +++ b/docs/technical_reference/costing/uv_aop.rst @@ -4,7 +4,7 @@ UV with Advanced Oxidation Processes Costing Method Costing Method Parameters +++++++++++++++++++++++++ -The following parameters are constructed when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.uv_aop`) when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" @@ -14,7 +14,7 @@ The following parameters are constructed when applying the `cost_uv_aop` costing Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: +The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_uv_aop` costing method in the ``watertap_costing_package``: .. csv-table:: :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" @@ -52,7 +52,6 @@ Describe operating/maintenance costs..keep it concise where possible Code Documentation ------------------ -* :mod:`watertap.unit_models.uv_aop` * :mod:`watertap.costing.unit_models.uv_aop` References From 1786b10a9937ac6ffe97ee6d28bb97d90cc0bf14 Mon Sep 17 00:00:00 2001 From: Adam Atia Date: Thu, 25 Apr 2024 17:56:06 -0400 Subject: [PATCH 15/15] set overwrite to False again --- .../costing/automate_detailed_unit_costing_rst_file.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py index 1b82c2c79a..27d75d9ef4 100644 --- a/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py +++ b/docs/technical_reference/costing/automate_detailed_unit_costing_rst_file.py @@ -34,7 +34,7 @@ if __name__ == "__main__": # Toggle OVERWRITE to True to overwrite unit model costing rst files - OVERWRITE = True + OVERWRITE = False # Specify unit model costing filenames (e.g., "ion_exchange") that you want to overwrite # Otherwise, if list left empty, the default is to overwrite all files OVERWRITE_LIST = []