From f1d50c0565c43cbc2c6cbddee2aeb013844fcf08 Mon Sep 17 00:00:00 2001 From: Dan Gunter Date: Mon, 9 Feb 2026 09:34:32 -0800 Subject: [PATCH 1/8] reformatted Word content from Anca --- contact.md | 34 ++++++++++++ index.md | 13 +++-- projects.md | 145 ++++++++++++++++++++++++++++++++++------------------ 3 files changed, 139 insertions(+), 53 deletions(-) create mode 100644 contact.md diff --git a/contact.md b/contact.md new file mode 100644 index 0000000..ef9fb02 --- /dev/null +++ b/contact.md @@ -0,0 +1,34 @@ +--- +title: IDAES+ Contact and Support +--- +# IDAES+ Contact and Support + +The IDAES+ projects are a coalition of government, academic, and industry +partners building a community-based open-source platform for advanced process +simulation. + +## GitHub Discussions + +**Ask technical questions and engage with the community:** + +- IDAES: +- PrOMMiS: +- WaterTAP: +- PARETO: + +## Email Support + +**For private inquiries:** + +- IDAES: +- PrOMMiS: +- WaterTAP: +- CCSI: ccsi-support@??? +- PARETO: + +## Join Our Community + +Interested in staying updated with releases, progress, and announcements? + +Go to this [registration page](https://idaes.org/register/) to join our user +mailing lists. diff --git a/index.md b/index.md index 0c3af07..5de53bc 100644 --- a/index.md +++ b/index.md @@ -13,13 +13,17 @@ to search the combined documentation for the IDAES+ projects. Products Models User Interfaces + Contact & Support ``` ## IDAES+ Project Timeline -The IDAES+ projects (except Pyomo, which was released in 2008) began in 2010 with the -Carbon Capture Simulation Institute. The Python platform was begun in 2015, and since then -projects have built on this platform to address specific application challenges in areas +The IDAES+ projects (except Pyomo, which was released in 2008) began in 2010 +with the +Carbon Capture Simulation Institute. The Python platform was begun in 2015, and +since then +projects have built on this platform to address specific application challenges +in areas ranging from water and grid expansion planning to critical minerals. ```{image} _static/img/idaesplus_timeline.png @@ -29,7 +33,8 @@ ranging from water and grid expansion planning to critical minerals. ## IDAES Integrated Platform -The IDAES Integrated Platform addresses a wide range of energy challenges with advanced +The IDAES Integrated Platform addresses a wide range of energy challenges with +advanced optimization and modeling software. ```{image} _static/img/idaesplus_platform.png diff --git a/projects.md b/projects.md index 9c670c1..396ee92 100644 --- a/projects.md +++ b/projects.md @@ -3,52 +3,99 @@ title: IDAES+ Projects --- # IDAES+ Projects -````{datatemplate:yaml} data.yaml -```{raw} html - - - - IDAES+ Projects - - - -
- - - - - -``` -```` +This is the unified documentation website for the IDAES+ projects, providing a +single entry point for the Institute for the Design of Advanced Energy Systems +(IDAES) and related projects. + +Click on one of the pages below to browse, or use the **search** function to +search the combined documentation for the IDAES+ projects. + +## IDAES Integrated Platform + +The Institute for the Design of Advanced Energy Systems (IDAES) is an +open-source, equation-oriented process systems engineering platform developed to +support the design, optimization, and analysis of complex energy and chemical +processes. Besides a comprehensive library of unit models, thermophysical +property packages, and reaction kinetics, IDAES offers a suite of advanced tools +and functionalities for optimization, conceptual design, uncertainty +quantification, parameter estimation, science-based design of experiments, +robust optimization, all designed to accelerate the development of sustainable +and cost-effective energy systems. + +- Website: [idaes.org](https://idaes.org/) +- GitHub : [github.com/IDAES/idaes-pse](https://github.com/IDAES/idaes-pse) +- Documentation: +- Examples and tutorials covering everything from single unit operations to + complete process flowsheets (like the HDA process example): + +- YouTube channel with overview, installation, and tutorial videos: + + +## PrOMMiS (Process Optimization and Modeling for Minerals Sustainability) + +PrOMMiS is an open-source software platform developed to accelerate the +development and deployment of extraction and purification processes for critical +minerals and rare earth elements (REEs). By providing advanced modeling and +optimization tools, PrOMMiS aims to reduce the risks associated with scaling up +innovative technologies, thereby supporting national strategic objectives such +as securing supply chains and enhancing economic competitiveness. + +- Website: +- GitHub: [github.com/prommis/prommis](https://github.com/prommis/prommis) +- Documentation with examples and tutorials: + +## WaterTAP (Water Treatment and Planning) + +WaterTAP is an open-source, optimization-based software platform developed under +the U.S. Department of Energy's National Alliance for Water Innovation (NAWI) +initiative. It enables detailed technoeconomic assessments of water treatment +systems, facilitating the design, simulation, and optimization of treatment +trains across a variety of water sources, sectors, and scales. + +- Website: +- GitHub: + [github.com/watertap-org/watertap](https://github.com/watertap-org/watertap) +- Documentation with tutorials: + +## Carbon Capture Simulation for Industry Impact (CCSI²) + +Designed for collaboration between industry, academia, and national labs, +CCSI^2^ offers an integrated suite of validated models for simulating carbon +capture processes. With its advanced computational tools for assessing and +reducing uncertainties in system performance and proven methodology to optimize +experimental designs, CCSI² enables the acceleration of the development and +deployment of cost-effective carbon capture technologies. + +- Website: +- GitHub: + +## DISPATCHES (Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems) + +Developed to support the design, optimization, and analysis of tightly coupled +hybrid energy systems that integrate various energy generation, storage, and +conversion technologies, DISPATCHES is an open-source computational platform +that provides detailed dynamic models coupled with nonlinear model predictive +control to simulate system behavior under varying market conditions. + +- Website: +- GitHub: + [github.com/gmlc-dispatches/dispatches](https://github.com/gmlc-dispatches/dispatches) +- Documentation: + [dispatches.readthedocs.io](https://dispatches.readthedocs.io/) + +## PARETO (Produced Water Application for Beneficial Reuse, Environmental Impact, and Treatment Optimization) + +PARETO is an open-source, optimization-based decision-support tool designed to +assist stakeholders in the oil and gas industry by facilitating the management, +treatment, and beneficial reuse of produced water. PARETO provides a +downloadable and executable produced water decision-support application that can +be run by upstream operators, midstream companies, technology providers, water +end users, research organizations and regulators. By leveraging PARETO, +organizations can make informed decisions that promote cost-effective and +environmentally sustainable practices in produced water management. + +- Website: +- GitHub: + [github.com/project-pareto/project-pareto](https://github.com/project-pareto/project-pareto/) +- Documentation with tutorials and examples: + From b17691988ce2318088eb5126fc1257ae226ea6bd Mon Sep 17 00:00:00 2001 From: Dan Gunter Date: Fri, 6 Mar 2026 09:21:38 -0800 Subject: [PATCH 2/8] airtable-less version --- data.yaml | 6946 +++++++++++++++++++++++++++++++----------- data/models.csv | 1191 ++++++++ data/products.csv | 13 + data/projects.csv | 8 + data/ui_products.csv | 8 + update_data.py | 361 +-- 6 files changed, 6475 insertions(+), 2052 deletions(-) create mode 100644 data/models.csv create mode 100644 data/products.csv create mode 100644 data/projects.csv create mode 100644 data/ui_products.csv diff --git a/data.yaml b/data.yaml index caa29f1..be0edb9 100644 --- a/data.yaml +++ b/data.yaml @@ -1,142 +1,283 @@ models: -- configurations: database, process_subtype, isothermal, isobaric +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: NRTL and Wilson activity coefficient methods + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Activity coefficient model + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/activity_coeff_models/activity_coeff_prop_pack.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Example property package for the VLE calculations for a Benzene-Toluene-o-Xylene... + flowsheet_module: '' + full_description: 'Example property package for the VLE calculations for a Benzene-Toluene-o-Xylene + + system. If using the activity coefficient models (NRTL or Wilson), the user is + + expected to provide the parameters necessary for these models. ' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'Activity coefficient model: benzene-toluene-xylene VLE' + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Property package for the VLE calculations for methane combustion. + + system.' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'Activity coefficient model: methane combustion' + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/activity_coeff_models/methane_combustion_ideal.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: outlet_state_defined, has_phase_equilibrium, inlet_property_package, + inlet_property_package_args, outlet_property_package, outlet_property_package_args, + reaction_package, reaction_package_args + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec0XgcZ9a3HBMrLy - name: Ozone (ZO) + inherited_model_(name,_unit_model): Translator + inherited_model_repository: idaes/models/unit_models/translator.py + mandatory_config_options: '' + name: ADM1 to ASM1 Translator project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + ADM1ParameterBlock ASM1ParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/adm1_properties.py + watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/adm1_properties.py - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock + watertap/property_models/unit_specific/activated_sludge/asm1_properties.py' + property_packages: 'ADM1ParameterBlock + + ASM1ParameterBlock (Liq phase)' reaction_package: '' + reaction_package_data: + ADM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py + reaction_package_repositories: watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py + reaction_packages: ADM1ReactionParameterBlock + specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, + pressure, volumetric flowrate, solute compositions, cations, anions). unit_model_data: - OzoneZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/ozone_zo.py - unit_model_repositories: watertap/unit_models/zero_order/ozone_zo.py - unit_models: OzoneZO -- configurations: database, process_subtype, isothermal, isobaric + Translator_ADM1_ASM1: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/translators/translator_adm1_asm1.py + unit_model_repositories: watertap/unit_models/translators/translator_adm1_asm1.py + unit_models: Translator_ADM1_ASM1 +- configurations: outlet_state_defined, has_phase_equilibrium, inlet_property_package, + inlet_property_package_args, outlet_property_package, outlet_property_package_args, + inlet_reaction_package, inlet_reaction_package_args, outlet_reaction_package, + outlet_reaction_package_args + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec0c02MSvMGgGKGo - name: SMP (ZO) + inherited_model_(name,_unit_model): Translator + inherited_model_repository: idaes/models/unit_models/translator.py + mandatory_config_options: '' + name: ADM1 to ASM2d Translator project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + ModifiedADM1ParameterBlock ModifiedASM2dParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py + + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py' + property_packages: 'ModifiedADM1ParameterBlock + + ModifiedASM2dParameterBlock' + reaction_package: '' + reaction_package_data: + ModifiedADM1ReactionParameterBlock ModifiedASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py + reaction_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py + + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py' + reaction_packages: 'ModifiedADM1ReactionParameterBlock - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + ModifiedASM2dReactionParameterBlock' + specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, + pressure, volumetric flowrate, solute compositions). + unit_model_data: + Translator_ADM1_ASM2D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/translators/translator_adm1_asm2d.py + unit_model_repositories: watertap/unit_models/translators/translator_adm1_asm2d.py + unit_models: Translator_ADM1_ASM2D +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Aeration Basin (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - SMPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/smp_zo.py - unit_model_repositories: watertap/unit_models/zero_order/smp_zo.py - unit_models: SMPZO -- configurations: outlet_list, num_outlets (not used if outlet_list arg is provided), - split_basis, material_balance_type, momentum_balance_type, has_phase_equilibrium, - energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports + AerationBasinZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/aeration_basin_zo.py + unit_model_repositories: watertap/unit_models/zero_order/aeration_basin_zo.py + unit_models: AerationBasinZO +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_heat_transfer, has_pressure_change, has_equilibrium_reactions, has_phase_equilibrium, + has_heat_of_reaction, electricity_consumption, has_aeration + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec1xYGL28tlx52Cp - inherited_model_(name,_unit_model): Separator, Separator - inherited_model_repository: idaes/models/unit_models/separator.py - name: Clarifier + inherited_model_(name,_unit_model): CSTR Injection, CSTR_Injection + inherited_model_repository: watertap/unit_models/cstr_injection.py + mandatory_config_options: '' + name: Aeration Tank project: WaterTAP property_package: '' property_package_data: - ASM1ParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - property_package_repositories: watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - property_packages: ASM1ParameterBlock (Liq phase) + ASM1ParameterBlock ASM2dParameterBlock ModifiedASM2dParameterBlock ADM1ParameterBlock (Single Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_properties.py; + + watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py; + + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py; + + watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' + property_packages: 'ASM1ParameterBlock + + ASM2dParameterBlock + + ModifiedASM2dParameterBlock + + ADM1ParameterBlock + + (Single Liq phase)' reaction_package: '' - specifications_for_operating_conditions: "Inlet feed state variables (temperature,\ - \ pressure, component flowrates), alkalinity, split fraction, surface area.\n\ - Degrees of freedom based on the separation type chosen:\nsplit_basis = \u2018\ - componentFlow\u2019, DOF = (#outlets - 1) * #components\nsplit_basis = \u2018\ - phaseFlow\u2019, DOF = (#outlets - 1) * #phases\nsplit_basis = \u2018phaseComponentFlow\u2019\ - \ or split_basis = \u2018totalFlow\u2019, DOF = (#outlets - 1) * #components *\ - \ #phases" + reaction_package_data: + ASM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py + watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py + ASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py + reaction_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py + + watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py + + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py; + + watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py' + reaction_packages: 'ASM1ReactionParameterBlock; + + ASM2dReactionParameterBlock; + + ModifiedASM2dReactionParameterBlock; + + ADM1ReactionParameterBlock' + specifications_for_operating_conditions: 'Inlet feed state variables (i.e. temperature, + pressure, component flowrates), volume or hydraulic retention time, injection + rates for all components, lumped mass transfer coefficient for oxygen*, dissolved + oxygen concentration at equilibrium*, if heat transfer is included: heat duty, + if pressure change is included: change in pressure. + + *These degrees of freedom should only be included if the oxygen injection rate + is not specified and needs to be calculated.' unit_model_data: - Clarifier: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/clarifier.py - unit_model_repositories: watertap/unit_models/clarifier.py - unit_models: Clarifier + AerationTank: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/aeration_tank.py + unit_model_repositories: watertap/unit_models/aeration_tank.py + unit_models: AerationTank - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec2Akmi39SNicMzP - name: Granular Activated Carbon (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Air Flotation (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - GACZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/gac_zo.py - unit_model_repositories: watertap/unit_models/zero_order/gac_zo.py - unit_models: GACZO -- description: This is an example flowsheet for the separation of lithium and magnesium - ions us... - flowsheet_module: prommis/nanofiltration/nf_brine.py - full_description: 'This is an example flowsheet for the separation of lithium and - magnesium ions using nanofiltration (NF). The unit model is the Donnan Steric - Pore Model with Dielectric Exclusion (DSPM-DE) and the property model is the Multi-Component - Aqueous Solution (MCAS) property package, both of which can be found in WaterTAP. - Currently, the inlet feed is modeling the Salar de Atacama brine. - - - The objective of the Pyomo model is to limit the amount of lithium lost in the - retentate stream, with 2 degrees of freedom (pressure, area). Operating at this - extreme end of the tradeoff between the selectivity and permeability, combined - with the low solvent flux for this example, the magnesium rejection is low (~14%). - An additional constraint is enacted on the model to limit the feed pressure to - 70 bar, per typical experimental capabilities. - - - Good references for details on the NF model, i.e., the DSPM-DE model: https://doi.org/10.1021/acs.est.2c08584 - ; https://doi.org/10.1016/j.memsci.2020.118809' - id: rec2YfPResgVqP9iy - name: Nanofiltration - project: PrOMMiS + AirFlotationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/air_flotation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/air_flotation_zo.py + unit_models: AirFlotationZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Air separation phase equilibrium package using Peng-Robinson EoS. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Air separation equilibrium, Peng-Robinson + project: IDAES property_package: '' - property_package_data: - MCASParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack - property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack - property_packages: MCASParameterBlock + property_package_repositories: idaes/models/properties/modular_properties/examples/ASU_PR.py + property_packages: '' reaction_package: '' - specifications_for_operating_conditions: 'Inlet flowrate and concentrations; pump - efficiency, inlet temperature and pressure, and outlet pressure; nanofiltration - recovery, spacer porosity, channel height, velocity, area, outlet pressure, spacer - mixing efficiency, spacer mixing length, pore radius, membrane thickness, membrane - charge density, dielectric constant ' - unit_model_data: - NanofiltrationDSPMDE0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/nanofiltration_DSPMDE_0D - Pump: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_changer - unit_model_repositories: 'watertap/unit_models/nanofiltration_DSPMDE_0D; - - watertap/unit_models/pressure_changer' - unit_models: NanofiltrationDSPMDE0D; Pump + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: material_balance_type, energy_balance_type, momentum_balance_type, has_heat_transfer, has_pressure_change, has_equilibrium_reactions, has_phase_equilibrium, has_heat_of_reaction, liquid_property_package, liquid_property_package_args, vapor_property_package, vapor_property_package_args, reaction_package, reaction_package_args + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec2lSee6DrQEkAOF + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' mandatory_config_options: 'dynamic has_holdup @@ -169,196 +310,305 @@ models: unit_model_repositories: watertap/unit_models/anaerobic_digester.py unit_models: AD - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec2r1HdJl3I0rCu5 - name: Static Mixer (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Anaerobic Digestion (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - StaticMixerZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/static_mixer_zo.py - unit_model_repositories: watertap/unit_models/zero_order/static_mixer_zo.py - unit_models: StaticMixerZO -- configurations: number_of_tanks - description: The Leach Train unit model represents a series of leaching tanks in - which a soli... - flowsheet_module: '' - full_description: 'The Leach Train unit model represents a series of leaching tanks - in which a solid and liquid stream are contacted and - - undergo heterogeneous chemical reactions.' - id: rec2s2TISI778iuaT - name: Leaching - project: PrOMMiS - property_package: '' - property_package_data: - CoalRefuseParameters (solid): https://github.com/prommis/prommis/tree/main/src/prommis/src/prommis/solid_handling/crusher_solids_properties.py - LeachSolutionParameters (liquid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solids_properties - prommis/leaching/leach_solution_properties - property_package_repositories: 'prommis/leaching/leach_solids_properties prommis/leaching/leach_solution_properties; - - prommis/src/prommis/solid_handling/crusher_solids_properties.py' - property_packages: LeachSolutionParameters (liquid); CoalRefuseParameters (solid) - reaction_package: '' - reaction_package_data: - CoalRefuseLeachingReactions: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_reactions.py - reaction_package_repositories: prommis/leaching/leach_reactions.py - reaction_packages: CoalRefuseLeachingReactions - specifications_for_operating_conditions: Liquid inlet flowrate and concentrations, - solid inlet mass flowrate and fractions - unit_model_data: - LeachingTrain: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_train.py - unit_model_repositories: prommis/leaching/leach_train.py - unit_models: LeachingTrain + AnaerobicDigestionOxidationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/anaerobic_digestion_oxidation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/anaerobic_digestion_oxidation_zo.py + unit_models: AnaerobicDigestionOxidationZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec2wxXulQVJpGq1i - name: Photothermal Membrane (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Anaerobic Digestion Reactive (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - PhotothermalMembrane: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/photothermal_membrane_zo.py - unit_model_repositories: watertap/unit_models/zero_order/photothermal_membrane_zo.py - unit_models: PhotothermalMembrane -- configurations: database, process_subtype, isothermal, isobaric + AnaerobicDigestionReactiveZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/anaerobic_digestion_reactive_zo.py + unit_model_repositories: watertap/unit_models/zero_order/anaerobic_digestion_reactive_zo.py + unit_models: AnaerobicDigestionReactiveZO +- configurations: outlet_state_defined, has_phase_equilibrium, inlet_property_package, + inlet_property_package_args, outlet_property_package, outlet_property_package_args, + reaction_package, reaction_package_args + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec328eymdCggHhw9 - name: Wind-Aided Intensified Evaporation Unit (ZO) + inherited_model_(name,_unit_model): Translator + inherited_model_repository: idaes/models/unit_models/translator.py + mandatory_config_options: '' + name: ASM1 to ADM1 Translator project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + ASM1ParameterBlock ADM1ParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + watertap/property_models/unit_specific/activated_sludge/adm1_properties.py + property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock + watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' + property_packages: 'ASM1ParameterBlock + + ADM1ParameterBlock (Liq phase)' reaction_package: '' + reaction_package_data: + ADM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py + reaction_package_repositories: watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py + reaction_packages: ADM1ReactionParameterBlock + specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, + pressure, volumetric flowrate, solute compositions, cations, anions). unit_model_data: - WAIVZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/waiv_zo.py - unit_model_repositories: watertap/unit_models/zero_order/waiv_zo.py - unit_models: WAIVZO -- configurations: material_balance_type, energy_balance_type, momentum_balance_type, - concentration_polarization_type, mass_transfer_coefficient, transport_model, module_type, - has_pressure_change, pressure_change_type, friction_factor, has_full_reporting - control_volume_data: - MembraneChannel0DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/core/membrane_channel0d.py - control_volume_repositories: watertap/core/membrane_channel0d.py - control_volumes: MembraneChannel0DBlock + Translator_ASM1_ADM1: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/translators/translator_asm1_adm1.py + unit_model_repositories: watertap/unit_models/translators/translator_asm1_adm1.py + unit_models: Translator_ASM1_ADM1 +- configurations: outlet_state_defined, has_phase_equilibrium, inlet_property_package, + inlet_property_package_args, outlet_property_package, outlet_property_package_args, + bio_P, inlet_reaction_package, inlet_reaction_package_args, outlet_reaction_package, + outlet_reaction_package_args + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec37Yf0fs5iPC59w - inherited_model_(name,_unit_model): OsmoticallyAssistedReverseOsmosisBaseData - inherited_model_repository: watertap/unit_models/osmotically_assisted_reverse_osmosis_base.py - name: Osmotically Assisted Reverse Osmosis (0D) + inherited_model_(name,_unit_model): Translator + inherited_model_repository: idaes/models/unit_models/translator.py + mandatory_config_options: '' + name: ASM2d to ADM1 Translator project: WaterTAP property_package: '' property_package_data: - ? 'NaClParameterBlock + ModifiedADM1ParameterBlock ModifiedASM2dParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py - property_package_repositories: watertap/property_models/NaCl_prop_pack.py - property_packages: 'NaClParameterBlock + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py' + property_packages: 'ModifiedADM1ParameterBlock - (Liq phase)' + ModifiedASM2dParameterBlock' reaction_package: '' - specifications_for_operating_conditions: 'Feed-side and permeate-side inlet state - variables (i.e, temperature, pressure, component mass flowrates), membrane area, - membrane water permeability A, membrane salt permeability B, structural parameter - (i.e., effective thickness). - - If concentration polarization effects, mass transfer coefficient, and pressure - drop are calculated: feed-side and permeate-side spacer porosity, channel height, - and feed-side Reynolds number or water mass recovery. + reaction_package_data: + ModifiedADM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py + ModifiedASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py + reaction_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py; - If has_pressure_change is set to True: pressure drop. + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py' + reaction_packages: 'ModifiedADM1ReactionParameterBlock; - If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: - concentration polarization modulus in feed and permeate channels. + ModifiedASM2dReactionParameterBlock' + specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, + pressure, volumetric flowrate, solute compositions). + unit_model_data: + Translator_ASM2d_ADM1: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/translators/translator_asm2d_adm1.py + unit_model_repositories: watertap/unit_models/translators/translator_asm2d_adm1.py + unit_models: Translator_ASM2d_ADM1 +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Autothermal Hydrothermal Liquefaction (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: - mass transfer coefficient in feed and permeate channels. + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ATHTLZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/autothermal_hydrothermal_liquefaction_zo.py + unit_model_repositories: watertap/unit_models/zero_order/autothermal_hydrothermal_liquefaction_zo.py + unit_models: ATHTLZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Backwash Solids Handling (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type - is not set to PressureChangeType.fixed_per_stage: membrane length. + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + BackwashSolidsHandlingZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/backwash_solids_handling_zo.py + unit_model_repositories: watertap/unit_models/zero_order/backwash_solids_handling_zo.py + unit_models: BackwashSolidsHandlingZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Benzene-Toluene phase equilibrium package using ideal liquid and vapor. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Benzene-toluene equilibrium, ideal + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/BT_ideal.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Benzene-toluene phase equilibrium package for liquid and vapor using + the Peng-Ro... + flowsheet_module: '' + full_description: Benzene-toluene phase equilibrium package for liquid and vapor + using the Peng-Robinson equation of state. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Benzene-toluene equilibrium, Peng-Robinson + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/BT_PR.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Bio Active Filtration (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side - and permeate-side average pressure drop per unit length. + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + BioActiveFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/bio_active_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/bio_active_filtration_zo.py + unit_models: BioActiveFiltrationZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Bioreactor (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If pressure_change_type is set to PressureChangeType.calculated: friction factor, - feed-side and permeate-side velocity and pressure drop per unit length.' + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - OsmoticallyAssistedReverseOsmosis0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/osmotically_assisted_reverse_osmosis_0D.py - unit_model_repositories: watertap/unit_models/osmotically_assisted_reverse_osmosis_0D.py - unit_models: OsmoticallyAssistedReverseOsmosis0D -- configurations: has_pressure_change, pressure_drop_method, friction_factor_method, - hydraulic_diameter_method, operation_mode, limiting_current_density_method_bpm, - salt_calculation, limiting_current_density_data_bpm, salt_input_cem, salt_input_aem, - limiting_potential_data, material_balance_type, is_isothermal, energy_balance_type, - momentum_balance_type, transformation_method, transformation_scheme, finite_elements, - terms_fE, collocation_points + BioreactorZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/bioreactor_zo.py + unit_model_repositories: watertap/unit_models/zero_order/bioreactor_zo.py + unit_models: BioreactorZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec3K1b5pPHGgRx7m - name: Electrodialysis w/ bipolar membranes (1D) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Blending Reservoir (ZO) project: WaterTAP property_package: '' property_package_data: - MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py - property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py - property_packages: MCASParameterBlock (Liq phase) + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, - pressure, component molar flowrates). Water transport number, water permeability, - dissociation rate constant at no electric field, relative permittivity, catalyst - - CEL of the bipolar membrane, catalyst - AEL of the bipolar membrane, equilibrium - constant of proton disassociation, equilibrium constant of hydroxide disassociation, - ion transference number in the membrane phase, diffusivity of solute in the membrane - phase, fixed salt concentration on the base and acid channel of the bipolar membrane - (if no salt calculation), spacer porosity, shadow factor, electrode areal resistance, - current utilization coefficient, channel height, cell width and length, constant - areal resistance of membrane at infinity-approximated electrolyte concentration, - membrane areal resistance coefficient to the reciprocal of the ion concentration, - thickness of ion exchange membranes, cell triplet number, spacer conductivity - coefficient, potential drop across the bipolar membrane, specific area of the - channel (if hydraulic diameter method is set for spacer-filled channel requiring - the spacer specific area data), membrane fixed charge, voltage or current applied - (for constant voltage or constant current electrical operation mode). + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - Electrodialysis_Bipolar_1D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/electrodialysis_bipolar_1D.py - unit_model_repositories: watertap/unit_models/electrodialysis_bipolar_1D.py - unit_models: Electrodialysis_Bipolar_1D + BlendingReservoirZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/blending_reservoir_zo.py + unit_model_repositories: watertap/unit_models/zero_order/blending_reservoir_zo.py + unit_models: BlendingReservoirZO - configurations: material_balance_type, energy_balance_type, momentum_balance_type, - has_pressure_change, reagent, precipitate + is_isothermal, chemical_mapping_data + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec41u2dsaazuAtz1 - name: Stoichiometric reactor + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Boron Removal project: WaterTAP property_package: '' property_package_data: @@ -366,217 +616,1168 @@ models: property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py property_packages: MCASParameterBlock (Liq phase) reaction_package: '' - specifications_for_operating_conditions: 'Inlet state variables (i.e., temperature, - pressure, component mass compositions). If reagents are supplied: reagent mass - flow rate or reagent dose. If precipitants are supplied: precipitant mass flow - rate, mass fraction of solids in precipitant (solid) waste stream.' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, + pressure, component molar flowrates), caustic chemical dose rate, reactor volume. unit_model_data: - StoichiometricReactor: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/stoichiometric_reactor.py - unit_model_repositories: watertap/unit_models/stoichiometric_reactor.py - unit_models: StoichiometricReactor -- description: The Crusher module includes power consumption for solid crushing. It - is a functi... + BoronRemoval: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/boron_removal.py + unit_model_repositories: watertap/unit_models/boron_removal.py + unit_models: BoronRemoval +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' flowsheet_module: '' - full_description: The Crusher module includes power consumption for solid crushing. - It is a function of particle size distribution, mass flow rate, and bond work - index. - id: rec4Bjj8l2HY81m7i - name: Crusher - project: PrOMMiS + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Brine Concentrator (ZO) + project: WaterTAP property_package: '' property_package_data: - CoalRefuseParameters: https://github.com/prommis/prommis/tree/main/src/prommis/solid_handling/crusher_solids_properties.py - property_package_repositories: prommis/solid_handling/crusher_solids_properties.py - property_packages: CoalRefuseParameters + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' reaction_package: '' - specifications_for_operating_conditions: Inlet mass flowrate and fractions, inlet - particle size median and width, outlet particle size median and width + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - Crusher: https://github.com/prommis/prommis/tree/main/src/prommis/solid_handling/crusher - unit_model_repositories: prommis/solid_handling/crusher - unit_models: Crusher + BrineConcentratorZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/brine_concentrator_zo.py + unit_model_repositories: watertap/unit_models/zero_order/brine_concentrator_zo.py + unit_models: BrineConcentratorZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Modular methods for calculating bubble and dew points. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Bubble and dew points + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/phase_equil/bubble_dew.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec4TmlMMsLojYSUL - name: Settling Pond (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Buffer Tank (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - SettlingPondZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/settling_pond_zo.py - unit_model_repositories: watertap/unit_models/zero_order/settling_pond_zo.py - unit_models: SettlingPondZO -- _2: ' has_pressure_change' - _3: ' metal_list' - _4: Pressure drop, gas inlet temperature, pressure, mole flowrate, and mole fractions, - gas outlet temperature, solid inlet temperature and mole flowrate, liquid inlet - flowrate and concentrations, recovery fraction - configurations: has_holdup; has_heat_transfer; has_pressure_change; metal_list - description: REE Oxalate Roaster is a unit operation to convert oxalates of rare - earth and ga... + BufferTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/buffer_tank_zo.py + unit_model_repositories: watertap/unit_models/zero_order/buffer_tank_zo.py + unit_models: BufferTankZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' flowsheet_module: '' - full_description: 'REE Oxalate Roaster is a unit operation to convert oxalates of - rare earth and gangue metal - - elements to metal oxides through thermal decomposition and oxidation. There are - 18 rare earth elements - - including `Sc`, `Y`, `La`, `Ce`, `Pr`, `Nd`, `Pm`, `Sm`, `Eu`, `Gd`, `Tb`, `Dy`, - `Ho`, `Er`, `Tm`, `Yb`, `Lu`, - - and `Th` in the model. The user can specify a subset of those 18 elements through - configuration when creating - - the unit model. The 3 gangue elements considered in the model are `Fe`, `Al`, - and `Ca`. - - - The feed oxalate mixture stream is typically from a precipitator in an upstream - process. It is assumed - - that all oxalates are in their hydrate forms. In case the anhydrous oxalate feed - flow rates are specified in - - the property package of the solid feed stream, the molar flow rates are converted - to the corresponding hydrate flow rates. - - The molecular formula of an oxalate hydrate can be expressed in a general form - as :ce:`RE2(C2O4)3 \\cdot xH2O` where RE is - - one of the 18 rare earth elements and x is the number of water molecules associated - with the hyrate. The three - - gangue oxalate hydrates considered in the model are :ce:`Fe2(C2O4)3 \\cdot 2H2O`, - :ce:`Al2(C2O4)3 \\cdot H2O`, and - - :ce:`CaC2O4 \\cdot H2O`, for `Fe`, `Al`, and `Ca` elements, respectively. - - - The feed stream contains surface moisture. The amount of surface moisture entering - the reactor is specified by - - a liquid inlet that contains a fraction of the liquid outlet of the precipitator.' - id: rec4gRQzVvTheQBgq - mandatory_config_options: ' has_heat_transfer' - name: Oxalate roaster - project: PrOMMiS + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: CANDO-P (ZO) + project: WaterTAP property_package: '' property_package_data: - AqueousParameter (liquid): https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_liquid_properties - CoalRefuseParameters (solid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solution_properties - GenericParameterBlock (gas): https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/modular_properties/base/generic_property - property_package_repositories: 'idaes/models/properties/modular_properties/base/generic_property; - - prommis/leaching/leach_solution_properties; + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - prommis/precipitate/precipitate_liquid_properties' - property_packages: "GenericParameterBlock (gas); \nCoalRefuseParameters (solid);\n\ - AqueousParameter (liquid)" + (Liq phase)' reaction_package: '' - specifications_for_operating_conditions: Pressure drop, gas inlet temperature, pressure, - mole flowrate, and mole fractions, gas outlet temperature, solid inlet temperature - and mole flowrate, liquid inlet flowrate and concentrations, recovery fraction + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - REEOxalateRoaster: https://github.com/prommis/prommis/tree/main/src/prommis/roasting/ree_oxalate_roaster - unit_model_repositories: prommis/roasting/ree_oxalate_roaster - unit_models: REEOxalateRoaster -- _2: ' AqueousParameter (aqueous)' - _3: ' PrecipitateParameters (precipitate)' - _4: ' REESolExOgParameters (organic)' - _5: ' GenericParameterBlock (gas)' - _6: prommis/leaching/leach_solids_properties prommis/leaching/leach_solution_properties - prommis/precipitate/precipitate_liquid_properties prommis.precipitate.precipitate_solids_properties - prommis.solvent_extraction.ree_og_distribution idaes/models.properties/modular_properties/base/generic_property - description: The University of Kentucky (UKy) rare earth element (REE) processing - plant is de... - flowsheet_module: prommis/uky/uky_flowsheet.py - full_description: 'The University of Kentucky (UKy) rare earth element (REE) processing - plant is designed to extract salable rare earth oxides from domestic U.S. coal - and coal byproducts. While this implementation of the plant does not take into - account + CANDOP: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/CANDOP_zo.py + unit_model_repositories: watertap/unit_models/zero_order/CANDOP_zo.py + unit_models: CANDOP +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Cartridge Filtration (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - all of the complexities and unit processes detailed in the 2019 report, it depicts - the major phenomena by utilizing a series of conventional REE extraction techniques, - including acid tank leaching, solvent extraction, precipitation, and product roasting.' - id: rec6RqTlLfSimqmDj - mandatory_config_options: ' CoalRefuseParameters (solid)' - name: REE processing plant - project: PrOMMiS + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CartridgeFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/cartridge_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/cartridge_filtration_zo.py + unit_models: CartridgeFiltrationZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Centrifuge (ZO) + project: WaterTAP property_package: '' property_package_data: - AqueousParameter (aqueous): https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_liquid_properties - CoalRefuseParameters (solid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solution_properties - GenericParameterBlock (gas): https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/modular_properties/base/generic_property - LeachSolutionParameters (liquid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solids_properties - PrecipitateParameters (precipitate): https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_solids_properties - REESolExOgParameters (organic): https://github.com/prommis/prommis/tree/main/src/prommis/solvent_extraction/ree_og_distribution - property_package_repositories: 'prommis/leaching/leach_solids_properties; + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - prommis/leaching/leach_solution_properties; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CentrifugeZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/centrifuge_zo.py + unit_model_repositories: watertap/unit_models/zero_order/centrifuge_zo.py + unit_models: CentrifugeZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Chemical Addition (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - prommis/precipitate/precipitate_liquid_properties; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ChemicalAdditionZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/chemical_addition_zo.py + unit_model_repositories: watertap/unit_models/zero_order/chemical_addition_zo.py + unit_models: ChemicalAdditionZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Chlorination (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - prommis/precipitate/precipitate_solids_properties; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ChlorinationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/chlorination_zo.py + unit_model_repositories: watertap/unit_models/zero_order/chlorination_zo.py + unit_models: ChlorinationZO +- configurations: outlet_list, num_outlets (not used if outlet_list arg is provided), + split_basis, material_balance_type, momentum_balance_type, has_phase_equilibrium, + energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): Separator, Separator + inherited_model_repository: idaes/models/unit_models/separator.py + mandatory_config_options: '' + name: Clarifier + project: WaterTAP + property_package: '' + property_package_data: + ASM1ParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + property_package_repositories: watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + property_packages: ASM1ParameterBlock (Liq phase) + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: "Inlet feed state variables (temperature,\ + \ pressure, component flowrates), alkalinity, split fraction, surface area.\n\ + Degrees of freedom based on the separation type chosen:\nsplit_basis = \u2018\ + componentFlow\u2019, DOF = (#outlets - 1) * #components\nsplit_basis = \u2018\ + phaseFlow\u2019, DOF = (#outlets - 1) * #phases\nsplit_basis = \u2018phaseComponentFlow\u2019\ + \ or split_basis = \u2018totalFlow\u2019, DOF = (#outlets - 1) * #components *\ + \ #phases" + unit_model_data: + Clarifier: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/clarifier.py + unit_model_repositories: watertap/unit_models/clarifier.py + unit_models: Clarifier +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Clarifier (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - prommis/solvent_extraction/ree_og_distribution; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ClarifierZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/clarifier_zo.py + unit_model_repositories: watertap/unit_models/zero_order/clarifier_zo.py + unit_models: ClarifierZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Cloth Media Filtration (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - idaes/models/properties/modular_properties/base/generic_property' - property_packages: LeachSolutionParameters (liquid); CoalRefuseParameters (solid); - AqueousParameter (aqueous); PrecipitateParameters (precipitate); REESolExOgParameters - (organic); GenericParameterBlock (gas) + (Liq phase)' reaction_package: '' - reaction_package_data: - CoalRefuseLeachingReactions: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_reactions - reaction_package_repositories: prommis/leaching/leach_reactions - reaction_packages: CoalRefuseLeachingReactions - specifications_for_operating_conditions: Leach liquid inlet flowrate and concentrations, - leach solid inlet mass flowrateand fractions, leach volume; rougher makeup stream - flowrate and concentrations; acid feeds (3) flowrate and concentrations; cleaner - make-up stream flowrate and concentrations; separators split fraction; sl separators - liquid recovery; precipitate temperature; roaster pressure drop, roaster gas inlet - temperature, pressure, mole flowrate and fraction, roaster gas outlet temperature, - roaster recovery fraction + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - LeachingTrain: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_train - Mixer: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/mixer - Precipitator: https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitator - REEOxalateRoaster: https://github.com/prommis/prommis/tree/main/src/prommis/roasting/ree_oxalate_roaster - SLSeparator: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/solid_liquid - Separator: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/separator - SolventExtraction: https://github.com/prommis/prommis/tree/main/src/prommis/solvent_extraction/solvent_extraction - unit_model_repositories: 'prommis/leaching/leach_train; + ClothMediaFiltration: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/cloth_media_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/cloth_media_filtration_zo.py + unit_models: ClothMediaFiltration +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: CO2 Addition (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - prommis/precipitate/precipitator; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CO2AdditionZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/co2_addition_zo.py + unit_model_repositories: watertap/unit_models/zero_order/co2_addition_zo.py + unit_models: CO2AdditionZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: CO2-bmimPF6 phase equilibrium package using ideal liquid and vapor. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: CO2-bmimPF6 phase equilibrium, Peng-Robinson + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/CO2_bmimPF6_PR.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Property package for MEA Carbon Capture System Condenser. CO2-H2O VLE + system, id... + flowsheet_module: '' + full_description: Property package for MEA Carbon Capture System Condenser. CO2-H2O + VLE system, ideal VLE with non-condensables. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: CO2-H2O VLE, ideal + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/CO2_H2O_Ideal_VLE.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Coagulation Flocculation (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - prommis/roasting/ree_oxalate_roaster; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CoagulationFlocculationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/coag_and_floc_zo.py + unit_model_repositories: watertap/unit_models/zero_order/coag_and_floc_zo.py + unit_models: CoagulationFlocculationZO +- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, + chemical_additives + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Coagulation-Flocculation + project: WaterTAP + property_package: '' + property_package_data: + NaClParameterBlock SeawaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py + watertap/property_models/seawater_prop_pack.py + property_package_repositories: 'watertap/property_models/NaCl_prop_pack.py - prommis/solvent_extraction/solvent_extraction; + watertap/property_models/seawater_prop_pack.py' + property_packages: 'NaClParameterBlock - idaes/models/unit_models/solid_liquid; + SeawaterParameterBlock - idaes/models/unit_models/mixer; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, + pressure, component mass flowrates), slope relationship between measured Turbidity + and TSS, intercept relationship between measured Turbidity and TSS, turbidity + measured before Jar Test, turbidity measured after Jar Test, chemical doses added + during Jar Test, retention time for each rapid mixer, number of rapid mixers in + series, rapid mixer velocity gradient, retention time of flocculation basin, flocculation + single paddle length (from center of rotation to blade edge), flocculation single + paddle width, flocculation paddle rotational speed, flocculation paddle drag coefficient, + flocculation paddle velocity fraction, number of rotating paddle wheels, number + of paddles per wheel + unit_model_data: + CoagulationFlocculation: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/coag_floc_model.py + unit_model_repositories: watertap/unit_models/coag_floc_model.py + unit_models: CoagulationFlocculation +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Cofermentation (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - idaes/models/unit_models/separator' - unit_models: LeachingTrain; Precipitator; REEOxalateRoaster; SolventExtraction; - SLSeparator; Mixer;Separator + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CofermentationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/cofermentation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/cofermentation_zo.py + unit_models: CofermentationZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: A complementarity-based vapor-liquid equilibrium formulation for equation-orient... + flowsheet_module: '' + full_description: 'A complementarity-based vapor-liquid equilibrium formulation + for equation-oriented simulation + + and optimization.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Complementarity-based vapor-liquid equilibrium formulation + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/phase_equil/smooth_VLE_2.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Isentropic compressor model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Compressor + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Compressor: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/pressure_changer.py + unit_model_repositories: idaes/models/unit_models/pressure_changer.py + unit_models: Compressor +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Constructed Wetlands (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ConstructedWetlandsZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/constructed_wetlands_zo.py + unit_model_repositories: watertap/unit_models/zero_order/constructed_wetlands_zo.py + unit_models: ConstructedWetlandsZO +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_heat_transfer, has_pressure_change, has_equilibrium_reactions, has_phase_equilibrium, + has_heat_of_reaction, property_package, property_package_args, reaction_package, + reaction_package_args + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES continuous stirred-tank model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Continuous stirred-tank reactor + project: IDAES + property_package: '' + property_package_data: + SaponificationParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_thermo.py + property_package_repositories: idaes/models/properties/examples/saponification_thermo.py + property_packages: SaponificationParameterBlock + reaction_package: '' + reaction_package_data: + SaponificationReactionParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_reactions.py + reaction_package_repositories: idaes/models/properties/examples/saponification_reactions.py + reaction_packages: SaponificationReactionParameterBlock + specifications_for_operating_conditions: Inlet feed state variables (molar flowrate, + component concentrations, temperature, pressure), heat duty, perssure drop + unit_model_data: + CSTR: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/cstr.py + unit_model_repositories: idaes/models/unit_models/cstr.py + unit_models: CSTR +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_heat_transfer, has_pressure_change, has_equilibrium_reactions, has_phase_equilibrium, + has_heat_of_reaction, reaction_package, reaction_package_args + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): CSTR, CSTR + inherited_model_repository: idaes/models/unit_models/cstr.py + mandatory_config_options: '' + name: Continuously Stirred Tank Reactor + project: WaterTAP + property_package: '' + property_package_data: + SaponificationParameterBlock ASM1ParameterBlock (Liq phase): https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_thermo.py + watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + property_package_repositories: ' + + idaes/models/properties/examples/saponification_thermo.py + + watertap/property_models/unit_specific/activated_sludge/asm1_properties.py' + property_packages: 'SaponificationParameterBlock + + ASM1ParameterBlock (Liq phase)' + reaction_package: '' + reaction_package_data: + ASM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py + SaponificationReactionParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_reactions.py + reaction_package_repositories: 'idaes/models/properties/examples/saponification_reactions.py; + + watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py' + reaction_packages: 'SaponificationReactionParameterBlock; + + ASM1ReactionParameterBlock' + specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, + pressure, component flowrates), volume or hydraulic retention time. + unit_model_data: + CSTR: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/cstr.py + unit_model_repositories: watertap/unit_models/cstr.py + unit_models: CSTR +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_heat_transfer, has_pressure_change, has_equilibrium_reactions, has_phase_equilibrium, + has_heat_of_reaction, reaction_package, reaction_package_args, electricity_consumption, + has_aeration + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Continuously Stirred Tank Reactor with Injection + project: WaterTAP + property_package: '' + property_package_data: + SaponificationParameterBlock ASM1ParameterBlock ASM2dParameterBlock ModifiedASM2dParameterBlock ADM1ParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_thermo.py + watertap/property_models/unit_specific/activated_sludge/asm1_properties.py watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + watertap/property_models/unit_specific/activated_sludge/adm1_properties.py + property_package_repositories: 'idaes/models/properties/examples/saponification_thermo.py + + watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + + watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py + + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + + watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' + property_packages: 'SaponificationParameterBlock + + ASM1ParameterBlock + + ASM2dParameterBlock + + ModifiedASM2dParameterBlock + + ADM1ParameterBlock' + reaction_package: '' + reaction_package_data: + ADM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py + ASM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py + ASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py + ModifiedASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py + SaponificationReactionParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_reactions.py + reaction_package_repositories: 'idaes/models/properties/examples/saponification_reactions.py; + + watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py; + + watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py; + + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py; + + watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py' + reaction_packages: 'SaponificationReactionParameterBlock; + + ASM1ReactionParameterBlock; + + ASM2dReactionParameterBlock; + + ModifiedASM2dReactionParameterBlock; + + ADM1ReactionParameterBlock' + specifications_for_operating_conditions: 'Inlet feed state variables (i.e. temperature, + pressure, component flowrates), volume or hydraulic retention time, injection + rates for all components, heat duty if heat transfer is included, change in pressure + if pressure change is included. If aeration is included, the following degrees + of freedom could replace the oxygen injection rate: lumped mass transfer coefficient + for oxygen, dissolved oxygen concentration at equilibrium.' + unit_model_data: + CSTR_Injection: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/cstr_injection.py + unit_model_repositories: watertap/unit_models/cstr_injection.py + unit_models: CSTR_Injection +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: PID controller model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Controller + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: 'idaes/models/control + + /controller.py' + unit_models: '' +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Conventional Activated Sludge (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CASZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/conventional_activated_sludge_zo.py + unit_model_repositories: watertap/unit_models/zero_order/conventional_activated_sludge_zo.py + unit_models: CASZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Cooling Supply (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CoolingSupplyZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/cooling_supply_zo.py + unit_model_repositories: watertap/unit_models/zero_order/cooling_supply_zo.py + unit_models: CoolingSupplyZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Cooling Tower (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + CoolingTowerZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/cooling_tower_zo.py + unit_model_repositories: watertap/unit_models/zero_order/cooling_tower_zo.py + unit_models: CoolingTowerZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Module for constructing CoolProp expressions and methods for looking + up and usin... + flowsheet_module: '' + full_description: 'Module for constructing CoolProp expressions and methods for + looking up and using CoolProp parameters + + within the IDAES generic properties framework.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Coolprop + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/coolprop + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Costing package that includes methods for capital costing of unit + operations. ' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Costing + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: idaes/models/costing/SSLW.py + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: The Crusher module includes power consumption for solid crushing. It + is a functi... + flowsheet_module: '' + full_description: The Crusher module includes power consumption for solid crushing. + It is a function of particle size distribution, mass flow rate, and bond work + index. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Crusher + project: PrOMMiS + property_package: '' + property_package_data: + CoalRefuseParameters: https://github.com/prommis/prommis/tree/main/src/prommis/solid_handling/crusher_solids_properties.py + property_package_repositories: prommis/solid_handling/crusher_solids_properties.py + property_packages: CoalRefuseParameters + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet mass flowrate and fractions, inlet + particle size median and width, outlet particle size median and width + unit_model_data: + Crusher: https://github.com/prommis/prommis/tree/main/src/prommis/solid_handling/crusher + unit_model_repositories: prommis/solid_handling/crusher + unit_models: Crusher +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Crystallizer (0D) + project: WaterTAP + property_package: '' + property_package_data: + NaClParameterBlock (solid-liquid-vapour mixtures): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py + property_package_repositories: watertap/property_models/NaCl_prop_pack.py + property_packages: 'NaClParameterBlock + + (solid-liquid-vapour mixtures)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet feed state variables (i.e. temperature, + pressure, component flowrates), crystal growth rate, desired median length of + solid crystals, parameter for Sounders-Brown relation, crystallization temperature. + To fully specify the unit: crystallization yield, solids volumetric fraction of + product slurry, magma density, solid outlet mass flow, vapour outlet mass flow' + unit_model_data: + Crystallization: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/crystallizer.py + unit_model_repositories: watertap/unit_models/crystallizer.py + unit_models: Crystallization +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Generic module for PR and SRK cubic equations of state + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Cubic Equations of State + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/eos + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Decarbonator (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + DecarbonatorZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/decarbonator_zo.py + unit_model_repositories: watertap/unit_models/zero_order/decarbonator_zo.py + unit_models: DecarbonatorZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Deep Well Injection (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + DeepWellInjectionZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/deep_well_injection_zo.py + unit_model_repositories: watertap/unit_models/zero_order/deep_well_injection_zo.py + unit_models: DeepWellInjectionZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Simple example of a flowsheet containing a Mixer, Heater and Flash + unit in series. + flowsheet_module: idaes/models/flowsheets/demo_flowsheet.py + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Demonstration flowsheet + project: IDAES + property_package: '' + property_package_data: + BTX_activity_coeff_VLE: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py + property_package_repositories: idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py + property_packages: BTX_activity_coeff_VLE + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Mixer Heater Flash: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models + unit_model_repositories: idaes/models/unit_models + unit_models: 'Mixer + + Heater + + Flash' +- configurations: activated_sludge_model, outlet_list, num_outlets (not used if outlet_list + arg is provided), split_basis, material_balance_type, momentum_balance_type, has_phase_equilibrium, + energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): Separator, Separator + inherited_model_repository: idaes/models/unit_models/separator.py + mandatory_config_options: '' + name: Dewatering Unit + project: WaterTAP + property_package: '' + property_package_data: + ASM1ParameterBlock ASM2dParameterBlock ModifiedASM2dParameterBlock ADM1ParameterBlock (Single Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + watertap/property_models/unit_specific/activated_sludge/adm1_properties.py + property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + + watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py + + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + + watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' + property_packages: 'ASM1ParameterBlock + + ASM2dParameterBlock + + ModifiedASM2dParameterBlock + + ADM1ParameterBlock + + (Single Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, + pressure, component mass compositions). + unit_model_data: + DewateringUnit: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/dewatering.py + unit_model_repositories: watertap/unit_models/dewatering.py + unit_models: DewateringUnit +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Diafiltration cascade flowsheet case study example for separating lithium + and co... + flowsheet_module: prommis/nanofiltraion/diafiltration.py + full_description: 'Diafiltration cascade flowsheet case study example for separating + lithium and cobalt. This flowsheet models a specific system from literature (cascade + III in Figure 2 [1]) and serves as an example of implementing a custom cost model. + + + [1] https://pubs.acs.org/doi/full/10.1021/acssuschemeng.2c02862' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: ' Stage 3 feed florate and concentrations' + name: Diafiltration + project: PrOMMiS + property_package: '' + property_package_data: + LiCoParameters: https://github.com/prommis/prommis/tree/main/src/prommis/nanofiltration/diafiltration_properties + property_package_repositories: prommis/nanofiltration/diafiltration_properties + property_packages: LiCoParameters + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Diafiltrate feed (Mixer 2) flowrate and + concentrations; Stage 3 feed florate and concentrations + unit_model_data: + MSContactor (3 units): https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models + Mixer (2 units): https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models + unit_model_repositories: idaes/models/unit_models + unit_models: MSContactor (3 units); Mixer (2 units) +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Dissolved Air Flotation (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + DissolvedAirFlotationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/dissolved_air_flotation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/dissolved_air_flotation_zo.py + unit_models: DissolvedAirFlotationZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Dual Media Filtration (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + DualMediaFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/dual_media_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/dual_media_filtration_zo.py + unit_models: DualMediaFiltrationZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Electrochemical Nutrient Removal (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ElectrocoagulationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/electrocoagulation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/electrocoagulation_zo.py + unit_models: ElectrocoagulationZO +- configurations: database, process_subtype, isothermal, isobaric, electrode_material, + reactor_material, overpotential_calculation + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Electrocoagulation (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ElectrodialysisReversalZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/electrodialysis_reversal_zo.py + unit_model_repositories: watertap/unit_models/zero_order/electrodialysis_reversal_zo.py + unit_models: ElectrodialysisReversalZO +- configurations: has_pressure_change, pressure_drop_method, friction_factor_method, + hydraulic_diameter_method, operation_mode, limiting_current_density_method, limiting_current_density_data, + has_nonohmic_potential_membrane, has_Nernst_diffusion_layer, material_balance_type, + is_isothermal, energy_balance_type, momentum_balance_type + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Electrodialysis (0D) + project: WaterTAP + property_package: '' + property_package_data: + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, + pressure, component molar flowrates). Water transport number, water permeability, + voltage or current, electrode areal resistance, cell pair number, current utilization + coefficient, spacer thickness, membrane areal resistance, cell width, cell length, + thickness of ion exchange membranes, diffusivity of solute in the membrane phase, + transport number of ions in the membrane phase. + unit_model_data: + Electrodialysis0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/electrodialysis_0D.py + unit_model_repositories: watertap/unit_models/electrodialysis_0D.py + unit_models: Electrodialysis0D - configurations: has_pressure_change, pressure_drop_method, friction_factor_method, hydraulic_diameter_method, operation_mode, limiting_current_density_method, limiting_current_density_datahas_nonohmic_potential_membrane, has_Nernst_diffusion_layer, material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, transformation_method, transformation_scheme, finite_elements, collocation_points + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec6UnXsEEEifqnOV + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' name: Electrodialysis (1D) project: WaterTAP property_package: '' @@ -585,6 +1786,8 @@ models: property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py property_packages: MCASParameterBlock (Liq phase) reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, pressure, component molar flowrates). Water transport number, water permeability, voltage or current, electrode areal resistance, cell pair number, current utilization @@ -598,546 +1801,1200 @@ models: unit_model_repositories: watertap/unit_models/electrodialysis_1D.py unit_models: Electrodialysis1D - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec7T6JS2YARGRlor - name: Ultra Filtration (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Electrodialysis Reversal (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - UltraFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/ultra_filtration_zo.py - unit_model_repositories: watertap/unit_models/zero_order/ultra_filtration_zo.py - unit_models: UltraFiltrationZO -- configurations: database, process_subtype, isothermal, isobaric, fix_pump_power + ElectroNPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/electrochemical_nutrient_removal_zo.py + unit_model_repositories: watertap/unit_models/zero_order/electrochemical_nutrient_removal_zo.py + unit_models: ElectroNPZO +- configurations: has_pressure_change, pressure_drop_method, friction_factor_method, + hydraulic_diameter_method, operation_mode, limiting_current_density_method_bpm, + salt_calculation, limiting_current_density_data_bpm, salt_input_cem, salt_input_aem, + limiting_potential_data, material_balance_type, is_isothermal, energy_balance_type, + momentum_balance_type, transformation_method, transformation_scheme, finite_elements, + terms_fE, collocation_points + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec7ukbo8jgbCtzOj - name: Water Pumping Station (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Electrodialysis w/ bipolar membranes (1D) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, + pressure, component molar flowrates). Water transport number, water permeability, + dissociation rate constant at no electric field, relative permittivity, catalyst + - CEL of the bipolar membrane, catalyst - AEL of the bipolar membrane, equilibrium + constant of proton disassociation, equilibrium constant of hydroxide disassociation, + ion transference number in the membrane phase, diffusivity of solute in the membrane + phase, fixed salt concentration on the base and acid channel of the bipolar membrane + (if no salt calculation), spacer porosity, shadow factor, electrode areal resistance, + current utilization coefficient, channel height, cell width and length, constant + areal resistance of membrane at infinity-approximated electrolyte concentration, + membrane areal resistance coefficient to the reciprocal of the ion concentration, + thickness of ion exchange membranes, cell triplet number, spacer conductivity + coefficient, potential drop across the bipolar membrane, specific area of the + channel (if hydraulic diameter method is set for spacer-filled channel requiring + the spacer specific area data), membrane fixed charge, voltage or current applied + (for constant voltage or constant current electrical operation mode). unit_model_data: - WaterPumpingStationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/water_pumping_station_zo.py - unit_model_repositories: watertap/unit_models/zero_order/water_pumping_station_zo.py - unit_models: WaterPumpingStationZO + Electrodialysis_Bipolar_1D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/electrodialysis_bipolar_1D.py + unit_model_repositories: watertap/unit_models/electrodialysis_bipolar_1D.py + unit_models: Electrodialysis_Bipolar_1D +- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Electrolyzer + project: WaterTAP + property_package: '' + property_package_data: + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet state variables (i.e., temperature, + pressure, component flowrates), membrane current density, anode current density, + anode overpotential, cathode current density, cathode overpotential, current, + current efficiency, resistance. The electrolysis reactions at the anode and cathode + must be specified for their stoichiometry and electrochemical potential. + unit_model_data: + Electrolyzer: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/electrolyzer.py + unit_model_repositories: watertap/unit_models/electrolyzer.py + unit_models: Electrolyzer - configurations: outlet_list, num_outlets (not used if outlet_list arg is provided), split_basis, material_balance_type, momentum_balance_type, has_phase_equilibrium, - energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports, - activated_sludge_model + energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec7vHLndRR37erWe inherited_model_(name,_unit_model): Separator, Separator inherited_model_repository: idaes/models/unit_models/separator.py - name: Thickener + mandatory_config_options: '' + name: ElectroNP (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'ASM1ParameterBlock - - ASM2dParameterBlock - - ModifiedASM2dParameterBlock - - (Single Liq phase)' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - - watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py' - property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - - watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py' - property_packages: 'ASM1ParameterBlock - - ASM2dParameterBlock - - ModifiedASM2dParameterBlock - - (Single Liq phase)' + ModifiedASM2dParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + property_package_repositories: watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py + property_packages: ModifiedASM2dParameterBlock (Liq phase) reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, - pressure, component mass compositions, alkalinity, volumetric flowrate). + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet state variables (i.e., temperature, + pressure, volumetric flowrate), electricity intensity, dosage of magnesium chloride + per phosphorus removal, inlet solute concentration. unit_model_data: - Thickener: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/thickener.py - unit_model_repositories: watertap/unit_models/thickener.py - unit_models: Thickener + ElectroNPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/electroNP_ZO.py + unit_model_repositories: watertap/unit_models/electroNP_ZO.py + unit_models: ElectroNPZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec8k0dLMFPW16QI3 - name: CO2 Addition (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Energy Recovery (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - CO2AdditionZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/co2_addition_zo.py - unit_model_repositories: watertap/unit_models/zero_order/co2_addition_zo.py - unit_models: CO2AdditionZO + EnergyRecoveryZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/energy_recovery_zo.py + unit_model_repositories: watertap/unit_models/zero_order/energy_recovery_zo.py + unit_models: EnergyRecoveryZO - configurations: material_balance_type, energy_balance_type, momentum_balance_type, - concentration_polarization_type, mass_transfer_coefficient, transport_model, module_type, - has_pressure_change, pressure_change_type, friction_factor, has_full_reporting - control_volume_data: - MembraneChannel0DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/core/membrane_channel0d.py - control_volume_repositories: watertap/core/membrane_channel0d.py - control_volumes: MembraneChannel0DBlock + has_phase_equilibrium, compressor, thermodynamic_assumption, support_isentropic_performance_curves, + isentropic_performance_curves, isentropic_performance_curves (build_callback, + build_head_expressions), variable_efficiency + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec9QOxkP2rQZOEts - inherited_model_(name,_unit_model): ReverseOsmosisBaseData - inherited_model_repository: watertap/unit_models/reverse_osmosis_base.py - name: Reverse Osmosis (0D) + inherited_model_(name,_unit_model): Pump, Pump (class PumpIsothermalData) + inherited_model_repository: watertap/unit_models/pressure_changer.py + mandatory_config_options: '' + name: Energy Recovery Device project: WaterTAP property_package: '' property_package_data: - ? 'NaClParameterBlock + SeawaterParameterBlock MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: 'watertap/property_models/seawater_prop_pack.py - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py - property_package_repositories: watertap/property_models/NaCl_prop_pack.py - property_packages: 'NaClParameterBlock + watertap/property_models/multicomp_aq_sol_prop_pack.py' + property_packages: 'SeawaterParameterBlock + + MCASParameterBlock (Liq phase)' reaction_package: '' - specifications_for_operating_conditions: 'Inlet feed state variables (i.e., temperature, - pressure, component flowrates), membrane area, membrane water permeability A, - membrane salt permeability B, and permeate pressure. - - If concentration polarization effects, mass transfer coefficient, and pressure - drop are calculated: feed spacer porosity, feed channel height, and membrane length - or membrane width or inlet Reynolds number. - - If has_pressure_change is set to True: pressure drop. - - If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: - concentration polarization modulus in feed channel. - - If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: - mass transfer coefficient in feed channel. - - If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type - is set to PressureChangeType.calculated: feed channel height, hydraulic diameter, - spacer porosity, Reynolds number. - - If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type - is not set to PressureChangeType.fixed_per_stage: membrane length and width. + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Outlet pressure or pressure change across + the inlet and outlet, energy recovery device efficiency. + unit_model_data: + EnergyRecoveryDevice: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_changer.py + unit_model_repositories: watertap/unit_models/pressure_changer.py + unit_models: EnergyRecoveryDevice +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Generic model for Electrolyte Non-Random Two Liquid activity coefficient + model + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: eNRTL Activity Coefficient + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/eos + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Example for using the eNRTL model for aqueous solutions of NaCl and + KCl. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: eNRTL, aqueous solutions of NaCl and KCl + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/enrtl_H2O_NaCl_KCl.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Example of using the eNRTL model to model solutions of NaBr in mixed + solvents. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: eNRTL, solutions of NaBr in mixed solvents + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/enrtl_NaBr_mixed_solvent.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Span-Wager property package for CO2. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'Equation of State: Span-Wagner' + project: IDAES + property_package: '' + property_package_data: + SWCO2ParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/swco2.py + property_package_repositories: idaes/models/properties/swco2.py + property_packages: SWCO2ParameterBlock + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Methods for defining equilibrium reactions. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Equilibrium reactions forms + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: idaes/models/properties/modular_properties/reactions/equilibrium_forms.py + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: dynamic, has_holdup, material_balance_type, energy_balance_type, + momentum_balance_type, has_rate_reactions, has_equilibrium_reactions, has_phase_equilibrium, + has_heat_transfer, has_heat_of_reaction, has_pressure_change, property_package, + property_package_args, reaction_package, reaction_package_args + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES equilibrium reactor model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Equilibrium reactor + project: IDAES + property_package: '' + property_package_data: + SaponificationParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_thermo.py + property_package_repositories: idaes/models/properties/examples/saponification_thermo.py + property_packages: SaponificationParameterBlock + reaction_package: '' + reaction_package_data: + SaponificationReactionParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_reactions.py + reaction_package_repositories: idaes/models/properties/examples/saponification_reactions.py + reaction_packages: SaponificationReactionParameterBlock + specifications_for_operating_conditions: Inlet feed state variables (molar flowrate, + component concentrations, temperature, pressure), unit volume, heat duty, perssure + drop + unit_model_data: + EquilibriumReactor: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/equilibrium_reactor.py + unit_model_repositories: idaes/models/unit_models/equilibrium_reactor.py + unit_models: EquilibriumReactor +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: The Evaporation Pond model is a general purpose model for representing + evaporati... + flowsheet_module: '' + full_description: 'The Evaporation Pond model is a general purpose model for representing + evaporation ponds (both solar and enhanced). Currently, the model only supports + steady-state operation + + (although it could be easily extended to dynamics). The model also only supports + material balances with equilibrium reactions, as energy and momentum balances + are less meaningful given the open-air nature of these operations and the long-duration + time + + constants involved.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Evaporation pond + project: PrOMMiS + property_package: '' + property_package_data: + BrineParameters: https://github.com/prommis/prommis/tree/main/src/prommis/evaporation_pond/tests/example_properties + property_package_repositories: prommis/evaporation_pond/tests/example_properties + property_packages: BrineParameters + reaction_package: '' + reaction_package_data: + BrineReactionParameters: https://github.com/prommis/prommis/tree/main/src/prommis/evaporation_pond/tests.example_reactions + reaction_package_repositories: prommis/evaporation_pond/tests.example_reactions + reaction_packages: BrineReactionParameters + specifications_for_operating_conditions: Inlet flowrate and concentrations, surface + area, average pond depth, and evaporation rate + unit_model_data: + EvaporationPond: https://github.com/prommis/prommis/tree/main/src/prommis/evaporation_pond/evaporation_pond + unit_model_repositories: ' prommis/evaporation_pond/evaporation_pond' + unit_models: EvaporationPond +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Evaporation Pond (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side - average pressure drop per unit length. + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + EvaporationPondZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/evaporation_pond_zo.py + unit_model_repositories: watertap/unit_models/zero_order/evaporation_pond_zo.py + unit_models: EvaporationPondZO +- configurations: dynamic, has_holdup, property_package property_package_args + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES Feed block. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Feed + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Feed: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/feed.py + unit_model_repositories: idaes/models/unit_models/feed.py + unit_models: Feed +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Feed (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If pressure_change_type is set to PressureChangeType.calculated: friction factor, - feed-side velocity, and pressure drop per unit length. + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + FeedZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/feed_zo.py + unit_model_repositories: watertap/unit_models/zero_order/feed_zo.py + unit_models: FeedZO +- configurations: dynamic, has_holdup, material_balance_type, flash_type, property_package, + property_package_args + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES feed block with phase equilibrium. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Feed Flash + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + FeedFlash: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/feed_flash.py + unit_model_repositories: idaes/models/unit_models/feed_flash.py + unit_models: FeedFlash +- configurations: has_holdup; has_heat_transfer; has_pressure_change; ree_list + control_volume_repositories: '' + control_volumes: '' + description: This model represents a roaster/calcination unit for Rare Earth Element + (REE) fe... + flowsheet_module: '' + full_description: This model represents a roaster/calcination unit for Rare Earth + Element (REE) feedstock, which includes rare earth minerals, gangue/impurity minerals, + moisture, and combustible organic materials. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: ' has_pressure_change' + name: Feed roaster + project: PrOMMiS + property_package: '' + property_package_data: + CoalRefuseParameters (solid).: https://github.com/idaes/idaes-pse/tree/main/idaes/models.properties/modular_properties/base/generic_property + prommis/leaching/leach_solution_properties + GenericParameterBlock (gas): https://github.com/idaes/idaes-pse/tree/main/idaes/models.properties/modular_properties/base/generic_property + prommis/leaching/leach_solution_properties + property_package_repositories: 'idaes/models.properties/modular_properties/base/generic_property + prommis/leaching/leach_solution_properties ' + property_packages: GenericParameterBlock (gas); CoalRefuseParameters (solid). + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Pressure drop, gas inlet temperature, pressure, + mole flowrate, and mole fractions, gas outlet temperature, solid inlet temperature, + mass flowrate, mass fractions, REE concentrations, conversion ratios of insolubale + REE to dissovable REE, recovery fraction for REE and impurity + unit_model_data: + REEFeedRoaster: https://github.com/prommis/prommis/tree/main/src/prommis/roasting/ree_feed_roaster + unit_model_repositories: prommis/roasting/ree_feed_roaster + unit_models: REEFeedRoaster +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Feed Water Tank (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If transport_model is set to TransportModel.SKK (Speigler-Kedem-Katchalsky model): - reflection coefficient, alpha.' + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - ReverseOsmosis0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/reverse_osmosis_0D.py - unit_model_repositories: watertap/unit_models/reverse_osmosis_0D.py - unit_models: ReverseOsmosis0D + FeedWaterTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/feed_water_tank_zo.py + unit_model_repositories: watertap/unit_models/zero_order/feed_water_tank_zo.py + unit_models: FeedWaterTankZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rec9oJAtMFqGwCLTl - name: Screen (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Filter Press (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - ScreenZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/screen_zo.py - unit_model_repositories: watertap/unit_models/zero_order/screen_zo.py - unit_models: ScreenZO + FilterPressZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/filter_press_zo.py + unit_model_repositories: watertap/unit_models/zero_order/filter_press_zo.py + unit_models: FilterPressZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recA7FdsngAA9rCBK - name: Peracetic Acid Disinfection (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Fixed Bed (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - PeraceticAcidDisinfection: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/peracetic_acid_disinfection_zo.py - unit_model_repositories: watertap/unit_models/zero_order/peracetic_acid_disinfection_zo.py - unit_models: PeraceticAcidDisinfection -- configurations: activated_sludge_model, outlet_list, num_outlets (not used if outlet_list - arg is provided), split_basis, material_balance_type, momentum_balance_type, has_phase_equilibrium, - energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports - description: '' + FixedBedZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/fixed_bed_zo.py + unit_model_repositories: watertap/unit_models/zero_order/fixed_bed_zo.py + unit_models: FixedBedZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Flash unit model. flowsheet_module: '' - id: recAl9zTRq0OZDBEX - inherited_model_(name,_unit_model): Separator, Separator - inherited_model_repository: idaes/models/unit_models/separator.py - name: Dewatering Unit - project: WaterTAP + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Flash + project: IDAES property_package: '' property_package_data: - ? 'ASM1ParameterBlock - - ASM2dParameterBlock - - ModifiedASM2dParameterBlock - - ADM1ParameterBlock - - (Single Liq phase)' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - - watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' - property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + BTX_activity_coeff_VLE iapws95 GenericParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py + idaes/models/properties/iapws95.py idaes/models/properties/modular_properties/base/generic_property.py + idaes/models/properties/modular_properties/examples/BT_ideal.py + BT_ideal: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py + idaes/models/properties/iapws95.py idaes/models/properties/modular_properties/base/generic_property.py + idaes/models/properties/modular_properties/examples/BT_ideal.py + property_package_repositories: 'idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py - watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' - property_packages: 'ASM1ParameterBlock + idaes/models/properties/iapws95.py - ASM2dParameterBlock + idaes/models/properties/modular_properties/base/generic_property.py - ModifiedASM2dParameterBlock + idaes/models/properties/modular_properties/examples/BT_ideal.py' + property_packages: 'BTX_activity_coeff_VLE - ADM1ParameterBlock + iapws95 - (Single Liq phase)' + GenericParameterBlock, BT_ideal' reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, - pressure, component mass compositions). + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - DewateringUnit: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/dewatering.py - unit_model_repositories: watertap/unit_models/dewatering.py - unit_models: DewateringUnit + Flash: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/flash.py + unit_model_repositories: idaes/models/unit_models/flash.py + unit_models: Flash - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recBaFi68NSunMGX1 - name: Dual Media Filtration (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Gas Sparged Membrane (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - DualMediaFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/dual_media_filtration_zo.py - unit_model_repositories: watertap/unit_models/zero_order/dual_media_filtration_zo.py - unit_models: DualMediaFiltrationZO -- configurations: database, process_subtype, isothermal, isobaric - description: '' + GasSpargedMembraneZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/gas_sparged_membrane_zo.py + unit_model_repositories: watertap/unit_models/zero_order/gas_sparged_membrane_zo.py + unit_models: GasSpargedMembraneZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Gas viscosity at low pressures from Chapman Enskog theory using Lennard + Jones pa... flowsheet_module: '' - id: recBjTtR72VQ0XbIC - name: Anaerobic Digestion (ZO) - project: WaterTAP + full_description: Gas viscosity at low pressures from Chapman Enskog theory using + Lennard Jones parameters. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Gas viscosity at low pressures + project: IDAES property_package: '' - property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + property_package_repositories: idaes/models/properties/modular_properties/pure/ChapmanEnskog.py + property_packages: '' reaction_package: '' - unit_model_data: - AnaerobicDigestionOxidationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/anaerobic_digestion_oxidation_zo.py - unit_model_repositories: watertap/unit_models/zero_order/anaerobic_digestion_oxidation_zo.py - unit_models: AnaerobicDigestionOxidationZO -- configurations: database, process_subtype, isothermal, isobaric + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_pressure_change, tracked_solids_list + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recCKNexNBPhz2aDW - name: Recirculating Dynamic Membrane Bioreactor (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Generic Desalter Unit project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet state variables (i.e., temperature, + pressure, component mass compositions), water recovery or solids concentration + in brine* and water content of the brine*. + + *User must provide tracked solids list.' unit_model_data: - DMBRZOO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/dmbr_zo.py - unit_model_repositories: watertap/unit_models/zero_order/dmbr_zo.py - unit_models: DMBRZOO -- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, - chemical_additives + GenericDesalter: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/generic_desalter.py + unit_model_repositories: watertap/unit_models/generic_desalter.py + unit_models: GenericDesalter +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: General framework for supporting modular thermophsyical property packages. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Generic Property Framework + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/base/generic_property.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: General framework for supporting modular reaction packages. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Generic Reaction Framework + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: idaes/models/properties/modular_properties/base/generic_reaction.py + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_pressure_change + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recCRJIKGhnQ2qcQa - name: Coagulation-Flocculation + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Generic Separator Unit project: WaterTAP property_package: '' property_package_data: - ? 'NaClParameterBlock - - SeawaterParameterBlock - - (Liq phase)' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py - - watertap/property_models/seawater_prop_pack.py' - property_package_repositories: 'watertap/property_models/NaCl_prop_pack.py - - watertap/property_models/seawater_prop_pack.py' - property_packages: 'NaClParameterBlock - - SeawaterParameterBlock - - (Liq phase)' + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, - pressure, component mass flowrates), slope relationship between measured Turbidity - and TSS, intercept relationship between measured Turbidity and TSS, turbidity - measured before Jar Test, turbidity measured after Jar Test, chemical doses added - during Jar Test, retention time for each rapid mixer, number of rapid mixers in - series, rapid mixer velocity gradient, retention time of flocculation basin, flocculation - single paddle length (from center of rotation to blade edge), flocculation single - paddle width, flocculation paddle rotational speed, flocculation paddle drag coefficient, - flocculation paddle velocity fraction, number of rotating paddle wheels, number - of paddles per wheel + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet state variables (i.e., temperature, + pressure, component mass compositions), percent of component to remove from feed + stream, amount of chemical to add for operation (additive_dose). unit_model_data: - CoagulationFlocculation: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/coag_floc_model.py - unit_model_repositories: watertap/unit_models/coag_floc_model.py - unit_models: CoagulationFlocculation -- description: '' + GenericSeparation: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/generic_separation.py + unit_model_repositories: watertap/unit_models/generic_separation.py + unit_models: GenericSeparation +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES Gibbs reactor model. flowsheet_module: '' - id: recETN5XhGrnCvSs9 - name: Crystallizer (0D) - project: WaterTAP + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Gibbs reactor + project: IDAES property_package: '' property_package_data: - ? 'NaClParameterBlock + GenericParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/activity_coeff_models/methane_combustion_ideal.py + idaes/models/properties/modular_properties/base/generic_property.py idaes/models_extra/power_generation/properties/natural_gas_PR.py + MethaneParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/activity_coeff_models/methane_combustion_ideal.py + idaes/models/properties/modular_properties/base/generic_property.py idaes/models_extra/power_generation/properties/natural_gas_PR.py + property_package_repositories: 'idaes/models/properties/activity_coeff_models/methane_combustion_ideal.py - (solid-liquid-vapour mixtures)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py - property_package_repositories: watertap/property_models/NaCl_prop_pack.py - property_packages: 'NaClParameterBlock + idaes/models/properties/modular_properties/base/generic_property.py - (solid-liquid-vapour mixtures)' + idaes/models_extra/power_generation/properties/natural_gas_PR.py' + property_packages: GenericParameterBlock, MethaneParameterBlock reaction_package: '' - specifications_for_operating_conditions: 'Inlet feed state variables (i.e. temperature, - pressure, component flowrates), crystal growth rate, desired median length of - solid crystals, parameter for Sounders-Brown relation, crystallization temperature. - To fully specify the unit: crystallization yield, solids volumetric fraction of - product slurry, magma density, solid outlet mass flow, vapour outlet mass flow' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - Crystallization: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/crystallizer.py - unit_model_repositories: watertap/unit_models/crystallizer.py - unit_models: Crystallization -- configurations: database, process_subtype, isothermal, isobaric + GibbsReactor: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/gibbs_reactor.py + unit_model_repositories: idaes/models/unit_models/gibbs_reactor.py + unit_models: GibbsReactor +- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, + film_transfer_coefficient_type, surface_diffusion_coefficient_type, target_species, + finite_elements_ss_approximation + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recElPEsncGD7CIIp - name: Sedimentation (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Granular Activated Carbon (GAC) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet state variables (i.e., temperature, + pressure, component flowrates), Freundlich adsorption isotherm parameters, Stanton + number equation parameters, throughput ratio equation parameters, particle apparent + density, particle diameter, empty bed contact time, bed voidage or particle bulk + density, superficial velocity or bed length, effluent to inlet concentration ratio + at operational time or steady state approximation of average effluent to inlet + concentration ratio in operational time by trapezoid rule or bed volumes treated, + surface diffusion coefficient, liquid phase film transfer coefficient. + + When setting the configuration options to calculate the surface diffusion coefficient + and liquid phase film transfer coefficient: shape correction factor, particle + porosity, tortuosity of the path that the adsorbate must take as compared to the + radius, surface-to-pore diffusion flux ratio.' unit_model_data: - SedimentationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/sedimentation_zo.py - unit_model_repositories: watertap/unit_models/zero_order/sedimentation_zo.py - unit_models: SedimentationZO + GAC: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/gac.py + unit_model_repositories: watertap/unit_models/gac.py + unit_models: GAC - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recFPX6YGj9AxfhTE - name: Cofermentation (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Granular Activated Carbon (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - CofermentationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/cofermentation_zo.py - unit_model_repositories: watertap/unit_models/zero_order/cofermentation_zo.py - unit_models: CofermentationZO + GACZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/gac_zo.py + unit_model_repositories: watertap/unit_models/zero_order/gac_zo.py + unit_models: GACZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Simple 0D heat exchanger model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Heat exchanger 0D + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + HeatExchanger: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/gibbs_reactor.py + unit_model_repositories: idaes/models/unit_models/gibbs_reactor.py + unit_models: HeatExchanger +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Simple 1D heat exchanger model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Heat exchanger 1D + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + HeatExchanger1D: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/heat_exchanger_1D.py + unit_model_repositories: idaes/models/unit_models/heat_exchanger_1D.py + unit_models: HeatExchanger1D +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Extension of the IDAES 0D heat exchanger model for transient simulations. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Heat exchanger lumped capacitance + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + HeatExchangerLumpedCapacitance: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/heat_exchanger_lc.py + unit_model_repositories: idaes/models/unit_models/heat_exchanger_lc.py + unit_models: HeatExchangerLumpedCapacitance +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: IDAES heat exchanger model using effectiveness-NTU method. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Heat exchanger NTU + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + HeatExchangerNTU: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/heat_exchanger_ntu.py + unit_model_repositories: idaes/models/unit_models/heat_exchanger_ntu.py + unit_models: HeatExchangerNTU +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Methods for calculating heat of reaction. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Heat of reaction + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: idaes/models/properties/modular_properties/reactions/dh_rxn.py + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Simple 0D heater/cooler model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Heater + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Heater: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/heater.py + unit_model_repositories: idaes/models/unit_models/heater.py + unit_models: Heater +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: General framework for Helmholtz equation of state models. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Helmholtz Equation of State + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/helmholtz/helmholtz.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: IAPWS95 property package for water and steam. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'Helmholtz Equation of State: IAPWS95' + project: IDAES + property_package: '' + property_package_data: + Iapws95ParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/iapws95.py + property_package_repositories: idaes/models/properties/iapws95.py + property_packages: Iapws95ParameterBlock + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Methods for calculating fugacity of Henry's Law components. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Henry's Law + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/phase_equil/henry.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recFUlj1jobsHwTyW - name: Bioreactor (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: High-Rate Contact Stabilization (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - BioreactorZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/bioreactor_zo.py - unit_model_repositories: watertap/unit_models/zero_order/bioreactor_zo.py - unit_models: BioreactorZO + HRCSZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/hrcs_zo.py + unit_model_repositories: watertap/unit_models/zero_order/hrcs_zo.py + unit_models: HRCSZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Hydrocarbon processing phase equilibrium package using Peng-Robinson + EoS. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'Hydrocarbon processing phase equilibrium, Peng-Robinson ' + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/HC_PR.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Hydrocarbon processing vapor phase package using Peng-Robinson EoS. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Hydrocarbon processing vapor phase, Peng-Robinson + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/examples/HC_PR_vap.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recFmvDIra38eugkP - name: Seawater Onshore Intake (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Hydrothermal Gasification (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - SWOnshoreIntakeZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/sw_onshore_intake_zo.py - unit_model_repositories: watertap/unit_models/zero_order/sw_onshore_intake_zo.py - unit_models: SWOnshoreIntakeZO + HTGZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/hydrothermal_gasification_zo.py + unit_model_repositories: watertap/unit_models/zero_order/hydrothermal_gasification_zo.py + unit_models: HTGZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Generic module for ideal gas and liquid properties + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Ideal Gases and Liquids + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/eos + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recGBrgt48dwNjARr - name: UV with Advanced Oxidation Processes (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Injection Well Disposal (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' - reaction_package: '' - unit_model_data: - UVAOPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/uv_aop_zo.py - unit_model_repositories: watertap/unit_models/zero_order/uv_aop_zo.py - unit_models: UVAOPZO + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + InjectionWellDisposalZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/injection_well_disposal_zo.py + unit_model_repositories: watertap/unit_models/zero_order/injection_well_disposal_zo.py + unit_models: InjectionWellDisposalZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recGP0B3UMPBSIerX - name: Modular Encapsulated Two-stage Anaerobic Biological Reactor (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Integrated Anaerobic Membrane Bioreactor/Microbial Electrolysis Cell (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - MetabZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/metab_zo.py - unit_model_repositories: watertap/unit_models/zero_order/metab_zo.py - unit_models: MetabZO + AnaerobicMBRMECZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/anaerobic_mbr_mec_zo.py + unit_model_repositories: watertap/unit_models/zero_order/anaerobic_mbr_mec_zo.py + unit_models: AnaerobicMBRMECZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recGSgRKRZRvQLgV5 - name: Media Filtration (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Intrusion Mitigation (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - MediaFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/media_filtration_zo.py - unit_model_repositories: watertap/unit_models/zero_order/media_filtration_zo.py - unit_models: MediaFiltrationZO + IntrusionMitigationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/intrusion_mitigation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/intrusion_mitigation_zo.py + unit_models: IntrusionMitigationZO - configurations: material_balance_type, energy_balance_type, momentum_balance_type, - has_pressure_change, tracked_solids_list + target_ion, regenerant, hazardous_waste, isotherm + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recGf7r0Toi23SDX1 - name: Generic Desalter Unit + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Ion Exchange (0D) project: WaterTAP property_package: '' property_package_data: @@ -1145,540 +3002,864 @@ models: property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py property_packages: MCASParameterBlock (Liq phase) reaction_package: '' - specifications_for_operating_conditions: 'Inlet state variables (i.e., temperature, - pressure, component mass compositions), water recovery or solids concentration - in brine* and water content of the brine*. + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet feed state variables (temperature, + pressure, component molar flowrate), resin bead diameter, resin bulk density, + bed porosity, service flow rate or superficial velocity through bed, number of + operational columns. - *User must provide tracked solids list.' + If isotherm is set to langmuir: Langmuir isotherm coefficient, resin maximum capacity, + dimensionless time. + + If isotherm is set to freundlich: Freundlich isotherm exponent, bed volumes of + feed at breakthru concentration, dimensionless (relative) concentration of target + ion, bed volumes of feed at 50 percent breakthrough or mass transfer coefficient + for Clark model (kT).' unit_model_data: - GenericDesalter: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/generic_desalter.py - unit_model_repositories: watertap/unit_models/generic_desalter.py - unit_models: GenericDesalter + IonExchange0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/ion_exchange_0D.py + unit_model_repositories: watertap/unit_models/ion_exchange_0D.py + unit_models: IonExchange0D - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recHRZiXoqnkI7J0p - name: Anaerobic Digestion Reactive (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Ion Exchange (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - AnaerobicDigestionReactiveZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/anaerobic_digestion_reactive_zo.py - unit_model_repositories: watertap/unit_models/zero_order/anaerobic_digestion_reactive_zo.py - unit_models: AnaerobicDigestionReactiveZO + IonExchangeZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/ion_exchange_zo.py + unit_model_repositories: watertap/unit_models/zero_order/ion_exchange_zo.py + unit_models: IonExchangeZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recHupGr4edxUksTi - name: Membrane Evaporator (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Iron And Manganese Removal (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - MembraneEvaporator: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/membrane_evaporator_zo.py - unit_model_repositories: watertap/unit_models/zero_order/membrane_evaporator_zo.py - unit_models: MembraneEvaporator + IronManganeseRemovalZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/iron_and_manganese_removal_zo.py + unit_model_repositories: watertap/unit_models/zero_order/iron_and_manganese_removal_zo.py + unit_models: IronManganeseRemovalZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recIArh3u0lpRnWxE - name: Conventional Activated Sludge (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Landfill (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - CASZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/conventional_activated_sludge_zo.py - unit_model_repositories: watertap/unit_models/zero_order/conventional_activated_sludge_zo.py - unit_models: CASZO -- configurations: database, process_subtype, isothermal, isobaric - description: '' + LandfillZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/landfill_zo.py + unit_model_repositories: watertap/unit_models/zero_order/landfill_zo.py + unit_models: LandfillZO +- configurations: number_of_tanks + control_volume_repositories: '' + control_volumes: '' + description: The Leach Train unit model represents a series of leaching tanks in + which a soli... flowsheet_module: '' - id: recILi2L1fCriAiUZ - name: Electrochemical Nutrient Removal (ZO) - project: WaterTAP + full_description: 'The Leach Train unit model represents a series of leaching tanks + in which a solid and liquid stream are contacted and + + undergo heterogeneous chemical reactions.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Leaching + project: PrOMMiS property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock + CoalRefuseParameters (solid): https://github.com/prommis/prommis/tree/main/src/prommis/src/prommis/solid_handling/crusher_solids_properties.py + LeachSolutionParameters (liquid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solids_properties + prommis/leaching/leach_solution_properties + property_package_repositories: 'prommis/leaching/leach_solids_properties prommis/leaching/leach_solution_properties; - (Liq phase)' + prommis/src/prommis/solid_handling/crusher_solids_properties.py' + property_packages: LeachSolutionParameters (liquid); CoalRefuseParameters (solid) reaction_package: '' + reaction_package_data: + CoalRefuseLeachingReactions: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_reactions.py + reaction_package_repositories: prommis/leaching/leach_reactions.py + reaction_packages: CoalRefuseLeachingReactions + specifications_for_operating_conditions: Liquid inlet flowrate and concentrations, + solid inlet mass flowrate and fractions unit_model_data: - ElectrocoagulationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/electrocoagulation_zo.py - unit_model_repositories: watertap/unit_models/zero_order/electrocoagulation_zo.py - unit_models: ElectrocoagulationZO -- configurations: outlet_list, num_outlets (not used if outlet_list arg is provided), - split_basis, material_balance_type, momentum_balance_type, has_phase_equilibrium, - energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports - description: '' + LeachingTrain: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_train.py + unit_model_repositories: prommis/leaching/leach_train.py + unit_models: LeachingTrain +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Eucken correlation to calculate low pressure pure component gas thermal + conductivity. flowsheet_module: '' - id: recIxQYsmMr1woJrC - inherited_model_(name,_unit_model): Separator, Separator - inherited_model_repository: idaes/models/unit_models/separator.py - name: ElectroNP (ZO) - project: WaterTAP + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Low pressure pure component gas thermal conductivity + project: IDAES property_package: '' - property_package_data: - ModifiedASM2dParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py - property_package_repositories: watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py - property_packages: ModifiedASM2dParameterBlock (Liq phase) + property_package_repositories: idaes/models/properties/modular_properties/pure/Eucken.py + property_packages: '' reaction_package: '' - specifications_for_operating_conditions: Inlet state variables (i.e., temperature, - pressure, volumetric flowrate), electricity intensity, dosage of magnesium chloride - per phosphorus removal, inlet solute concentration. - unit_model_data: - ElectroNPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/electroNP_ZO.py - unit_model_repositories: watertap/unit_models/electroNP_ZO.py - unit_models: ElectroNPZO + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recJZb1EFpWQqnXvB - name: Hydrothermal Gasification (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Magprex (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - HTGZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/hydrothermal_gasification_zo.py - unit_model_repositories: watertap/unit_models/zero_order/hydrothermal_gasification_zo.py - unit_models: HTGZO -- configurations: database, process_subtype, isothermal, isobaric + MagprexZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/magprex_zo.py + unit_model_repositories: watertap/unit_models/zero_order/magprex_zo.py + unit_models: MagprexZO +- configurations: Evaporator:, property_package_feed, property_package_args_feed, + property_package_vapor, property_package_args_vapor, material_balance_type, energy_balance_type, + momentum_balance_type, Compressor:, material_balance_type, energy_balance_type, + momentum_balance_type, Condenser:, material_balance_type, energy_balance_type, + momentum_balance_type + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recJcKDoSEZQCuHSf - name: Tramp Oil Tank (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'Mechanical Vapor Compression (MVC) + + Flowsheet' project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + SeawaterParameterBlock (Liq phase) WaterParameterBlock (Vap phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/water_prop_pack.py + property_package_repositories: 'watertap/property_models/seawater_prop_pack.py - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock + watertap/property_models/water_prop_pack.py' + property_packages: 'SeawaterParameterBlock (Liq phase) - (Liq phase)' + WaterParameterBlock (Vap phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet feed state variables (i.e, temperature, + pressure, component flowrates and mass fractions). Evaporator: 1 outlet condition + (brine or vapor temperature or pressure), overall heat transfer coefficient, area + for heat exchange. Compressor: pressure ratio, work (control volume variable), + isentropic efficiency. Pumps: pressure change across the inlet and outlet, pump + efficiency. Heat exchangers: overall heat transfer coefficient, area for heat + exchange, pressure change across the inlet and outlet.' unit_model_data: - TrampOilTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/tramp_oil_tank_zo.py - unit_model_repositories: watertap/unit_models/zero_order/tramp_oil_tank_zo.py - unit_models: TrampOilTankZO + Feed Separator Mixer Product (x2: https://github.com/watertap-org/watertap/tree/main/watertap/flowsheets/mvc/mvc_single_stage.py + idaes/models/unit_models/feed.py idaes/models/unit_models/separator.py idaes/models/unit_models/mixer.py + idaes/models/unit_models/product.py idaes/models/unit_models/translator.py idaes/models/unit_models/heat_exchanger.py + watertap/unit_models/mvc/components/evaporator.py watertap/unit_models/mvc/components/compressor.py + watertap/unit_models/mvc/components/complete_condenser.py watertap/unit_models/pressure_changer.py + brine: https://github.com/watertap-org/watertap/tree/main/watertap/flowsheets/mvc/mvc_single_stage.py + idaes/models/unit_models/feed.py idaes/models/unit_models/separator.py idaes/models/unit_models/mixer.py + idaes/models/unit_models/product.py idaes/models/unit_models/translator.py idaes/models/unit_models/heat_exchanger.py + watertap/unit_models/mvc/components/evaporator.py watertap/unit_models/mvc/components/compressor.py + watertap/unit_models/mvc/components/complete_condenser.py watertap/unit_models/pressure_changer.py + brine distillate) Translator HeatExchanger (x2: https://github.com/watertap-org/watertap/tree/main/watertap/flowsheets/mvc/mvc_single_stage.py + idaes/models/unit_models/feed.py idaes/models/unit_models/separator.py idaes/models/unit_models/mixer.py + idaes/models/unit_models/product.py idaes/models/unit_models/translator.py idaes/models/unit_models/heat_exchanger.py + watertap/unit_models/mvc/components/evaporator.py watertap/unit_models/mvc/components/compressor.py + watertap/unit_models/mvc/components/complete_condenser.py watertap/unit_models/pressure_changer.py + distillate): https://github.com/watertap-org/watertap/tree/main/watertap/flowsheets/mvc/mvc_single_stage.py + idaes/models/unit_models/feed.py idaes/models/unit_models/separator.py idaes/models/unit_models/mixer.py + idaes/models/unit_models/product.py idaes/models/unit_models/translator.py idaes/models/unit_models/heat_exchanger.py + watertap/unit_models/mvc/components/evaporator.py watertap/unit_models/mvc/components/compressor.py + watertap/unit_models/mvc/components/complete_condenser.py watertap/unit_models/pressure_changer.py + distillate) Evaporator Compressor Condenser Pump (x3: https://github.com/watertap-org/watertap/tree/main/watertap/flowsheets/mvc/mvc_single_stage.py + idaes/models/unit_models/feed.py idaes/models/unit_models/separator.py idaes/models/unit_models/mixer.py + idaes/models/unit_models/product.py idaes/models/unit_models/translator.py idaes/models/unit_models/heat_exchanger.py + watertap/unit_models/mvc/components/evaporator.py watertap/unit_models/mvc/components/compressor.py + watertap/unit_models/mvc/components/complete_condenser.py watertap/unit_models/pressure_changer.py + feed: https://github.com/watertap-org/watertap/tree/main/watertap/flowsheets/mvc/mvc_single_stage.py + idaes/models/unit_models/feed.py idaes/models/unit_models/separator.py idaes/models/unit_models/mixer.py + idaes/models/unit_models/product.py idaes/models/unit_models/translator.py idaes/models/unit_models/heat_exchanger.py + watertap/unit_models/mvc/components/evaporator.py watertap/unit_models/mvc/components/compressor.py + watertap/unit_models/mvc/components/complete_condenser.py watertap/unit_models/pressure_changer.py + unit_model_repositories: 'watertap/flowsheets/mvc/mvc_single_stage.py + + idaes/models/unit_models/feed.py + + idaes/models/unit_models/separator.py + + idaes/models/unit_models/mixer.py + + idaes/models/unit_models/product.py + + idaes/models/unit_models/translator.py + + idaes/models/unit_models/heat_exchanger.py + + watertap/unit_models/mvc/components/evaporator.py + + watertap/unit_models/mvc/components/compressor.py + + watertap/unit_models/mvc/components/complete_condenser.py + + watertap/unit_models/pressure_changer.py' + unit_models: 'Feed + + Separator + + Mixer + + Product (x2; brine distillate) + + Translator + + HeatExchanger (x2; brine, distillate) + + Evaporator + + Compressor + + Condenser + + Pump (x3, feed, brine, distillate)' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recJqz2GJa130LN5m - name: Municipal Wastewater Treatment Plant (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Media Filtration (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - MunicipalWWTPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/municipal_wwtp_zo.py - unit_model_repositories: watertap/unit_models/zero_order/municipal_wwtp_zo.py - unit_models: MunicipalWWTPZO + MediaFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/media_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/media_filtration_zo.py + unit_models: MediaFiltrationZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recKGoFfChpmrJ3uf - name: Buffer Tank (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Membrane Aerated Biofilm Reactor (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - BufferTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/buffer_tank_zo.py - unit_model_repositories: watertap/unit_models/zero_order/buffer_tank_zo.py - unit_models: BufferTankZO + MABRZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/mabr_zo.py + unit_model_repositories: watertap/unit_models/zero_order/mabr_zo.py + unit_models: MABRZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recKW738nHQsppn0W - name: Well Field (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Membrane Bioreactor (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - WellFieldZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/well_field_zo.py - unit_model_repositories: watertap/unit_models/zero_order/well_field_zo.py - unit_models: WellFieldZO + MBRZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/mbr_zo.py + unit_model_repositories: watertap/unit_models/zero_order/mbr_zo.py + unit_models: MBRZO - configurations: material_balance_type, energy_balance_type, momentum_balance_type, - is_isothermal, chemical_mapping_data + flow_direction, temperature_polarization_type, concentration_polarization_type, + mass_transfer_coefficient, has_pressure_change, pressure_change_type, friction_factor, + property_package_vapor, property_package_args_vapor, hot_ch, cold_ch, gap_ch, + MD_configuration_Type + control_volume_data: + MDChannel0DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/MD/MD_channel_0D.py + control_volume_repositories: watertap/unit_models/MD/MD_channel_0D.py + control_volumes: MDChannel0DBlock description: '' flowsheet_module: '' - id: recKhrhr8qs1kesb5 - name: Boron Removal + inherited_model_(name,_unit_model): MembraneDistillationBaseData + inherited_model_repository: watertap/unit_models/MD/membrane_distillation_base.py + mandatory_config_options: '' + name: Membrane Distillation (0D) project: WaterTAP property_package: '' property_package_data: - MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py - property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py - property_packages: MCASParameterBlock (Liq phase) + SeawaterParameterBlock WaterParameterBlock (Liq phase: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/water_prop_pack.py + vap phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/water_prop_pack.py + property_package_repositories: 'watertap/property_models/seawater_prop_pack.py + + watertap/property_models/water_prop_pack.py' + property_packages: 'SeawaterParameterBlock + + WaterParameterBlock + + (Liq phase, vap phase)' reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, - pressure, component molar flowrates), caustic chemical dose rate, reactor volume. + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Hot channel and cold channel inlet state + variables (i.e, temperature, pressure, and component flowrates), membrane permeability + coefficient, membrane thickness, membrane thermal conductivity, recovery or membrane + area. + + Additional degrees of freedom for: VMD (Vacuum Membrane Distillation) configuration, + pressure at the cold side; GMD (Permeate Gap/Conductive Gap Membrane Distillation) + configuration, gap thermal conductivity and gap thickness. + + If temperature polarization, concentration polarization, mass transfer coefficient + is computed: hot channel spacer porosity, hot channel height, cold channel spacer + porosity (in Direct Contact Membrane Distillation, DCMD, and GMD), cold channel + height (in DCMD and GMD, membrane length or membrane width' unit_model_data: - BoronRemoval: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/boron_removal.py - unit_model_repositories: watertap/unit_models/boron_removal.py - unit_models: BoronRemoval -- configurations: database, process_subtype, isothermal, isobaric + MembraneDistillation0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/MD/membrane_distillation_0D.py + unit_model_repositories: watertap/unit_models/MD/membrane_distillation_0D.py + unit_models: MembraneDistillation0D +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + flow_direction, temperature_polarization_type, concentration_polarization_type, + mass_transfer_coefficient, has_pressure_change, pressure_change_type, friction_factor, + property_package_vapor, property_package_args_vapor, hot_ch, cold_ch, gap_ch, + MD_configuration_Type, area_definition, transformation_method, transformation_scheme, + finite_elements, collocation_points + control_volume_data: + MDChannel1DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/MD/MD_channel_1D.py + control_volume_repositories: watertap/unit_models/MD/MD_channel_1D.py + control_volumes: MDChannel1DBlock description: '' flowsheet_module: '' - id: recL8Ild8lWLGRZ7H - name: Microscreen Filtration (ZO) + inherited_model_(name,_unit_model): MembraneDistillationBaseData + inherited_model_repository: watertap/unit_models/MD/membrane_distillation_base.py + mandatory_config_options: '' + name: Membrane Distillation (1D) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + SeawaterParameterBlock WaterParameterBlock (Liq phase: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/water_prop_pack.py + vap phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/water_prop_pack.py + property_package_repositories: 'watertap/property_models/seawater_prop_pack.py - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock + watertap/property_models/water_prop_pack.py' + property_packages: 'SeawaterParameterBlock - (Liq phase)' + WaterParameterBlock + + (Liq phase, vap phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Hot channel and cold channel inlet state + variables (i.e, temperature, pressure, and component flowrates), membrane permeability + coefficient, membrane thickness, membrane thermal conductivity, recovery or membrane + area. + + Additional degrees of freedom for: VMD (Vacuum Membrane Distillation) configuration, + vacuum pressure at the cold side; GMD (Permeate Gap/Conductive Gap Membrane Distillation) + configuration, gap thermal conductivity and gap thickness. + + If temperature polarization, concentration polarization, mass transfer coefficient + is computed: hot channel spacer porosity, hot channel height, cold channel spacer + porosity (in Direct Contact Membrane Distillation, DCMD, and GMD), cold channel + height (in DCMD and GMD, membrane length or membrane width.' unit_model_data: - MicroscreenFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/microscreen_filtration_zo.py - unit_model_repositories: watertap/unit_models/zero_order/microscreen_filtration_zo.py - unit_models: MicroscreenFiltrationZO + MembraneDistillation1D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/MD/membrane_distillation_1D.py + unit_model_repositories: watertap/unit_models/MD/membrane_distillation_1D.py + unit_models: MembraneDistillation1D - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recLuHqjpT5P5yTqi - name: Chlorination (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Membrane Evaporator (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - ChlorinationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/chlorination_zo.py - unit_model_repositories: watertap/unit_models/zero_order/chlorination_zo.py - unit_models: ChlorinationZO + MembraneEvaporator: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/membrane_evaporator_zo.py + unit_model_repositories: watertap/unit_models/zero_order/membrane_evaporator_zo.py + unit_models: MembraneEvaporator - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recMVl6WWDAtdhb7H - name: Blending Reservoir (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Microbial Battery (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - BlendingReservoirZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/blending_reservoir_zo.py - unit_model_repositories: watertap/unit_models/zero_order/blending_reservoir_zo.py - unit_models: BlendingReservoirZO + MicrobialBattery: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/microbial_battery_zo.py + unit_model_repositories: watertap/unit_models/zero_order/microbial_battery_zo.py + unit_models: MicrobialBattery - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recMfO7IAnVv2wqFV - name: CANDO-P (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Microfiltration (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - CANDOP: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/CANDOP_zo.py - unit_model_repositories: watertap/unit_models/zero_order/CANDOP_zo.py - unit_models: CANDOP + MicroFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/microfiltration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/microfiltration_zo.py + unit_models: MicroFiltrationZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recOJnj7FuhyDBzNk - name: Brine Concentrator (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Microscreen Filtration (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - BrineConcentratorZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/brine_concentrator_zo.py - unit_model_repositories: watertap/unit_models/zero_order/brine_concentrator_zo.py - unit_models: BrineConcentratorZO -- configurations: database, process_subtype, isothermal, isobaric - description: '' + MicroscreenFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/microscreen_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/microscreen_filtration_zo.py + unit_models: MicroscreenFiltrationZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: General purpose mixer block for IDAES models. flowsheet_module: '' - id: recObALg1pcLR2V23 - name: Cooling Tower (ZO) - project: WaterTAP + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Mixer + project: IDAES property_package: '' - property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + property_package_repositories: '' + property_packages: '' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - CoolingTowerZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/cooling_tower_zo.py - unit_model_repositories: watertap/unit_models/zero_order/cooling_tower_zo.py - unit_models: CoolingTowerZO + Mixer: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/mixer.py + unit_model_repositories: idaes/models/unit_models/mixer.py + unit_models: Mixer +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Wassiljew-Mason-Saxena rules to obtain mixture thermal conductivity + of a low pre... + flowsheet_module: '' + full_description: Wassiljew-Mason-Saxena rules to obtain mixture thermal conductivity + of a low pressure gas from component thermal conductivities. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Mixture thermal conductivity of a low pressure gas + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/transport_properties/thermal_conductivity_wms.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Wilke rules to obtain mixture viscosity of a low pressure gas from + pure componen... + flowsheet_module: '' + full_description: 'Wilke rules to obtain mixture viscosity of a low pressure gas + from pure component + + viscosities.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Mixture viscosity of a low pressure gas + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/transport_properties/viscosity_wilke.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recOlVlqrR4msbDDA - name: Backwash Solids Handling (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Modular Encapsulated Two-stage Anaerobic Biological Reactor (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - BackwashSolidsHandlingZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/backwash_solids_handling_zo.py - unit_model_repositories: watertap/unit_models/zero_order/backwash_solids_handling_zo.py - unit_models: BackwashSolidsHandlingZO + MetabZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/metab_zo.py + unit_model_repositories: watertap/unit_models/zero_order/metab_zo.py + unit_models: MetabZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: IDAES model for a generic multiple-stream contactor unit. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Multiple-stream contactor + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + MSContactor: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/mscontactor.py + unit_model_repositories: idaes/models/unit_models/mscontactor.py + unit_models: MSContactor - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recQ1ZXxfBgooOtc8 - name: Filter Press (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Municipal Drinking (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - FilterPressZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/filter_press_zo.py - unit_model_repositories: watertap/unit_models/zero_order/filter_press_zo.py - unit_models: FilterPressZO + MunicipalWaterZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/municipal_drinking_zo.py + unit_model_repositories: watertap/unit_models/zero_order/municipal_drinking_zo.py + unit_models: MunicipalWaterZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recQLf2NscKYSOTkW - name: Membrane Aerated Biofilm Reactor (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Municipal Wastewater Treatment Plant (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - MABRZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/mabr_zo.py - unit_model_repositories: watertap/unit_models/zero_order/mabr_zo.py - unit_models: MABRZO -- configurations: material_balance_type, energy_balance_type, momentum_balance_type - description: '' - flowsheet_module: '' - id: recRKtm93aho8S74Q - name: Steam Jet Ejector - project: WaterTAP + MunicipalWWTPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/municipal_wwtp_zo.py + unit_model_repositories: watertap/unit_models/zero_order/municipal_wwtp_zo.py + unit_models: MunicipalWWTPZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: This is an example flowsheet for the separation of lithium and magnesium + ions us... + flowsheet_module: prommis/nanofiltration/nf_brine.py + full_description: 'This is an example flowsheet for the separation of lithium and + magnesium ions using nanofiltration (NF). The unit model is the Donnan Steric + Pore Model with Dielectric Exclusion (DSPM-DE) and the property model is the Multi-Component + Aqueous Solution (MCAS) property package, both of which can be found in WaterTAP. + Currently, the inlet feed is modeling the Salar de Atacama brine. + + + The objective of the Pyomo model is to limit the amount of lithium lost in the + retentate stream, with 2 degrees of freedom (pressure, area). Operating at this + extreme end of the tradeoff between the selectivity and permeability, combined + with the low solvent flux for this example, the magnesium rejection is low (~14%). + An additional constraint is enacted on the model to limit the feed pressure to + 70 bar, per typical experimental capabilities. + + + Good references for details on the NF model, i.e., the DSPM-DE model: https://doi.org/10.1021/acs.est.2c08584 + ; https://doi.org/10.1016/j.memsci.2020.118809' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Nanofiltration + project: PrOMMiS property_package: '' property_package_data: - WaterParameterBlock (Liq phase, vap phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: WaterParameterBlock (Liq phase, vap phase) + MCASParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack + property_packages: MCASParameterBlock reaction_package: '' - specifications_for_operating_conditions: Inlet state variables (i.e., temperature, - pressure, and component flowrates for motive steam and entrained vapor). Entrainment - ratio, compression ratio. + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet flowrate and concentrations; pump + efficiency, inlet temperature and pressure, and outlet pressure; nanofiltration + recovery, spacer porosity, channel height, velocity, area, outlet pressure, spacer + mixing efficiency, spacer mixing length, pore radius, membrane thickness, membrane + charge density, dielectric constant ' unit_model_data: - SteamEjector: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/steam_ejector.py - unit_model_repositories: watertap/unit_models/steam_ejector.py - unit_models: SteamEjector -- configurations: material_balance_type, energy_balance_type, momentum_balance_type, - has_phase_equilibrium, compressor, thermodynamic_assumption, support_isentropic_performance_curves, - isentropic_performance_curves, isentropic_performance_curves (build_callback, - build_head_expressions), variable_efficiency, bep_flow*, bep_eta*, flow_ratio*, - *When variable_efficiency is not VariableEfficiency.none + NanofiltrationDSPMDE0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/nanofiltration_DSPMDE_0D + Pump: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_changer + unit_model_repositories: 'watertap/unit_models/nanofiltration_DSPMDE_0D; + + watertap/unit_models/pressure_changer' + unit_models: NanofiltrationDSPMDE0D; Pump +- configurations: momentum_balance_type, has_pressure_change, energy_balance_type, + electroneutrality_ion, passing_species_list, default_passing_rejection, default_excluded_rejection + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recRd3gCdwbeiBxVX - inherited_model_(name,_unit_model): Pressure changer, PressureChanger -> Pump, Pump - inherited_model_repository: idaes/models/unit_models/pressure_changer.py - name: Pump + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Nanofiltration (0D) project: WaterTAP property_package: '' property_package_data: - ? 'SeawaterParameterBlock - - MCASParameterBlock - - (Liq phase)' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py - - watertap/property_models/multicomp_aq_sol_prop_pack.py' - property_package_repositories: 'watertap/property_models/seawater_prop_pack.py - - watertap/property_models/multicomp_aq_sol_prop_pack.py' - property_packages: 'SeawaterParameterBlock - - MCASParameterBlock - - (Liq phase)' + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) reaction_package: '' - specifications_for_operating_conditions: Outlet pressure or pressure change across - the inlet and outlet, pump efficiency + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e, temperature, + pressure, component molar flowrates), permeate pressure, solvent recovery fraction, + solute rejection fractions for all solutes except the one identified as the electroneutrality + species, membrane area, retentate pressure drop unit_model_data: - Pump: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_changer.py - unit_model_repositories: watertap/unit_models/pressure_changer.py - unit_models: Pump -- configurations: database, process_subtype, isothermal, isobaric + Nanofiltration0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/nanofiltration_0D.py + unit_model_repositories: watertap/unit_models/nanofiltration_0D.py + unit_models: Nanofiltration0D +- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, + has_pressure_change + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recSKuoC9OnitU3Pc - name: Chemical Addition (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Nanofiltration (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py + property_packages: MCASParameterBlock (Liq phase) reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e, temperature, + pressure, solvent and solute mass flowrates). Membrane's solvent volumetric flux + rate, permeate pressure, membrane's solute rejection. If solutes are ionic and + contain multiple ion pairs, one ion's rejection may be unfixed for electroneutrality. + Another variable, such as volumetric recovery rate or membrane area, fixes the + last degree of freedom. unit_model_data: - ChemicalAdditionZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/chemical_addition_zo.py - unit_model_repositories: watertap/unit_models/zero_order/chemical_addition_zo.py - unit_models: ChemicalAdditionZO + NanofiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/nanofiltration_ZO.py + unit_model_repositories: watertap/unit_models/nanofiltration_ZO.py + unit_models: NanofiltrationZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recSa9o4XEIjJMMpe - name: Feed Water Tank (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Nanofiltration (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - FeedWaterTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/feed_water_tank_zo.py - unit_model_repositories: watertap/unit_models/zero_order/feed_water_tank_zo.py - unit_models: FeedWaterTankZO -- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, - film_transfer_coefficient_type, surface_diffusion_coefficient_type, target_species, - finite_elements_ss_approximation + NanofiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/nanofiltration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/nanofiltration_zo.py + unit_models: NanofiltrationZO +- configurations: material_balance_type, momentum_balance_type, has_pressure_change, + mass_transfer_coefficient, concentration_polarization_type + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recSiG4rMuE6weB7R - name: Granular Activated Carbon (GAC) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Nanofiltration- Donnan Steric Pore Model with Dielectric Exclusion (0D) project: WaterTAP property_package: '' property_package_data: @@ -1686,515 +3867,1008 @@ models: property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py property_packages: MCASParameterBlock (Liq phase) reaction_package: '' - specifications_for_operating_conditions: 'Inlet state variables (i.e., temperature, - pressure, component flowrates), Freundlich adsorption isotherm parameters, Stanton - number equation parameters, throughput ratio equation parameters, particle apparent - density, particle diameter, empty bed contact time, bed voidage or particle bulk - density, superficial velocity or bed length, effluent to inlet concentration ratio - at operational time or steady state approximation of average effluent to inlet - concentration ratio in operational time by trapezoid rule or bed volumes treated, - surface diffusion coefficient, liquid phase film transfer coefficient. + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e, temperature, + pressure, component molar flowrates), pore radius, membrane effective thickness, + membrane charge density, dielectric constant of medium (pore), permeate pressure, + spacer porosity, channel height, crossflow velocity in feed channel, membrane + area, mass transfer coefficient for each ion or spacer net mixing efficiency and + spacer characteristic length for calculating mass transfer coefficient with spiral + wound correlation + unit_model_data: + NanofiltrationDSPMDE0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/nanofiltration_DSPMDE_0D.py + unit_model_repositories: watertap/unit_models/nanofiltration_DSPMDE_0D.py + unit_models: NanofiltrationDSPMDE0D +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + concentration_polarization_type, mass_transfer_coefficient, transport_model, module_type, + has_pressure_change, pressure_change_type, friction_factor, has_full_reporting + control_volume_data: + MembraneChannel0DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/core/membrane_channel0d.py + control_volume_repositories: watertap/core/membrane_channel0d.py + control_volumes: MembraneChannel0DBlock + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): OsmoticallyAssistedReverseOsmosisBaseData + inherited_model_repository: watertap/unit_models/osmotically_assisted_reverse_osmosis_base.py + mandatory_config_options: '' + name: Osmotically Assisted Reverse Osmosis (0D) + project: WaterTAP + property_package: '' + property_package_data: + NaClParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py + property_package_repositories: watertap/property_models/NaCl_prop_pack.py + property_packages: 'NaClParameterBlock - When setting the configuration options to calculate the surface diffusion coefficient - and liquid phase film transfer coefficient: shape correction factor, particle - porosity, tortuosity of the path that the adsorbate must take as compared to the - radius, surface-to-pore diffusion flux ratio.' + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Feed-side and permeate-side inlet state + variables (i.e, temperature, pressure, component mass flowrates), membrane area, + membrane water permeability A, membrane salt permeability B, structural parameter + (i.e., effective thickness). + + If concentration polarization effects, mass transfer coefficient, and pressure + drop are calculated: feed-side and permeate-side spacer porosity, channel height, + and feed-side Reynolds number or water mass recovery. + + If has_pressure_change is set to True: pressure drop. + + If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: + concentration polarization modulus in feed and permeate channels. + + If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: + mass transfer coefficient in feed and permeate channels. + + If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type + is not set to PressureChangeType.fixed_per_stage: membrane length. + + If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side + and permeate-side average pressure drop per unit length. + + If pressure_change_type is set to PressureChangeType.calculated: friction factor, + feed-side and permeate-side velocity and pressure drop per unit length.' unit_model_data: - GAC: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/gac.py - unit_model_repositories: watertap/unit_models/gac.py - unit_models: GAC + OsmoticallyAssistedReverseOsmosis0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/osmotically_assisted_reverse_osmosis_0D.py + unit_model_repositories: watertap/unit_models/osmotically_assisted_reverse_osmosis_0D.py + unit_models: OsmoticallyAssistedReverseOsmosis0D - configurations: material_balance_type, energy_balance_type, momentum_balance_type, - has_heat_transfer, has_pressure_change, has_equilibrium_reactions, has_phase_equilibrium, - has_heat_of_reaction, reaction_package, reaction_package_args + concentration_polarization_type, mass_transfer_coefficient, transport_model, module_type, + has_pressure_change, pressure_change_type, friction_factor, area_definition, transformation_method, + transformation_scheme, finite_elements, collocation_points, has_full_reporting + control_volume_data: + MembraneChannel1DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/core/membrane_channel1d.py + control_volume_repositories: watertap/core/membrane_channel1d.py + control_volumes: MembraneChannel1DBlock description: '' flowsheet_module: '' - id: recT0OiYHMKT1c2aA - inherited_model_(name,_unit_model): CSTR, CSTR - inherited_model_repository: idaes/models/unit_models/cstr.py - name: Continuously Stirred Tank Reactor - project: WaterTAP - property_package: '' - property_package_data: - ? 'SaponificationParameterBlock + inherited_model_(name,_unit_model): OsmoticallyAssistedReverseOsmosisBaseData + inherited_model_repository: watertap/unit_models/osmotically_assisted_reverse_osmosis_base.py + mandatory_config_options: '' + name: Osmotically Assisted Reverse Osmosis (1D) + project: WaterTAP + property_package: '' + property_package_data: + NaClParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py + property_package_repositories: watertap/property_models/NaCl_prop_pack.py + property_packages: 'NaClParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Feed-side and permeate-side inlet state + variables (i.e, temperature, pressure, component mass flowrates), membrane area, + membrane water permeability A, membrane salt permeability B, structural parameter + (i.e., effective thickness). + + If concentration polarization effects, mass transfer coefficient, and pressure + drop are calculated: feed-side and permeate-side spacer porosity, channel height, + and feed-side Reynolds number or water mass recovery. + + If has_pressure_change is set to True: pressure drop. + + If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: + concentration polarization modulus in feed and permeate channels. + + If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: + mass transfer coefficient in feed and permeate channels. + + If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type + is not set to PressureChangeType.fixed_per_stage: membrane length and width. + + If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side + and permeate-side average pressure drop per unit length. + + If pressure_change_type is set to PressureChangeType.calculated: friction factor, + feed-side and permeate-side velocity and pressure drop per unit length.' + unit_model_data: + OsmoticallyAssistedReverseOsmosis1D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/osmotically_assisted_reverse_osmosis_1D.py + unit_model_repositories: watertap/unit_models/osmotically_assisted_reverse_osmosis_1D.py + unit_models: OsmoticallyAssistedReverseOsmosis1D +- configurations: has_holdup; has_heat_transfer; has_pressure_change; metal_list + control_volume_repositories: '' + control_volumes: '' + description: REE Oxalate Roaster is a unit operation to convert oxalates of rare + earth and ga... + flowsheet_module: '' + full_description: 'REE Oxalate Roaster is a unit operation to convert oxalates of + rare earth and gangue metal - ASM1ParameterBlock (Liq phase)' - : 'https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_thermo.py + elements to metal oxides through thermal decomposition and oxidation. There are + 18 rare earth elements - watertap/property_models/unit_specific/activated_sludge/asm1_properties.py' - property_package_repositories: ' + including `Sc`, `Y`, `La`, `Ce`, `Pr`, `Nd`, `Pm`, `Sm`, `Eu`, `Gd`, `Tb`, `Dy`, + `Ho`, `Er`, `Tm`, `Yb`, `Lu`, - idaes/models/properties/examples/saponification_thermo.py + and `Th` in the model. The user can specify a subset of those 18 elements through + configuration when creating - watertap/property_models/unit_specific/activated_sludge/asm1_properties.py' - property_packages: 'SaponificationParameterBlock + the unit model. The 3 gangue elements considered in the model are `Fe`, `Al`, + and `Ca`. - ASM1ParameterBlock (Liq phase)' - reaction_package: '' - reaction_package_data: - ASM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py - SaponificationReactionParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_reactions.py - reaction_package_repositories: 'idaes/models/properties/examples/saponification_reactions.py; - watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py' - reaction_packages: 'SaponificationReactionParameterBlock; + The feed oxalate mixture stream is typically from a precipitator in an upstream + process. It is assumed - ASM1ReactionParameterBlock' - specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, - pressure, component flowrates), volume or hydraulic retention time. - unit_model_data: - CSTR: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/cstr.py - unit_model_repositories: watertap/unit_models/cstr.py - unit_models: CSTR -- configurations: material_balance_type, energy_balance_type, momentum_balance_type, - has_phase_equilibrium, compressor, thermodynamic_assumption, support_isentropic_performance_curves, - isentropic_performance_curves, isentropic_performance_curves (build_callback, - build_head_expressions), variable_efficiency - description: '' - flowsheet_module: '' - id: recT0ownJYntD9843 - inherited_model_(name,_unit_model): Pump, Pump (class PumpIsothermalData) - inherited_model_repository: watertap/unit_models/pressure_changer.py - name: Energy Recovery Device - project: WaterTAP - property_package: '' - property_package_data: - ? 'SeawaterParameterBlock + that all oxalates are in their hydrate forms. In case the anhydrous oxalate feed + flow rates are specified in + + the property package of the solid feed stream, the molar flow rates are converted + to the corresponding hydrate flow rates. - MCASParameterBlock + The molecular formula of an oxalate hydrate can be expressed in a general form + as :ce:`RE2(C2O4)3 \\cdot xH2O` where RE is - (Liq phase)' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + one of the 18 rare earth elements and x is the number of water molecules associated + with the hyrate. The three - watertap/property_models/multicomp_aq_sol_prop_pack.py' - property_package_repositories: 'watertap/property_models/seawater_prop_pack.py + gangue oxalate hydrates considered in the model are :ce:`Fe2(C2O4)3 \\cdot 2H2O`, + :ce:`Al2(C2O4)3 \\cdot H2O`, and - watertap/property_models/multicomp_aq_sol_prop_pack.py' - property_packages: 'SeawaterParameterBlock + :ce:`CaC2O4 \\cdot H2O`, for `Fe`, `Al`, and `Ca` elements, respectively. - MCASParameterBlock - (Liq phase)' - reaction_package: '' - specifications_for_operating_conditions: Outlet pressure or pressure change across - the inlet and outlet, energy recovery device efficiency. - unit_model_data: - EnergyRecoveryDevice: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_changer.py - unit_model_repositories: watertap/unit_models/pressure_changer.py - unit_models: EnergyRecoveryDevice -- configurations: database, process_subtype, isothermal, isobaric - description: '' - flowsheet_module: '' - id: recTNZNtSAhhpT68i - name: Gas Sparged Membrane (ZO) - project: WaterTAP + The feed stream contains surface moisture. The amount of surface moisture entering + the reactor is specified by + + a liquid inlet that contains a fraction of the liquid outlet of the precipitator.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: ' has_heat_transfer' + name: Oxalate roaster + project: PrOMMiS property_package: '' property_package_data: - ? 'WaterParameterBlock + AqueousParameter (liquid): https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_liquid_properties + CoalRefuseParameters (solid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solution_properties + GenericParameterBlock (gas): https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/modular_properties/base/generic_property + property_package_repositories: 'idaes/models/properties/modular_properties/base/generic_property; - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock + prommis/leaching/leach_solution_properties; - (Liq phase)' + prommis/precipitate/precipitate_liquid_properties' + property_packages: 'GenericParameterBlock (gas); + + CoalRefuseParameters (solid); + + AqueousParameter (liquid)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Pressure drop, gas inlet temperature, pressure, + mole flowrate, and mole fractions, gas outlet temperature, solid inlet temperature + and mole flowrate, liquid inlet flowrate and concentrations, recovery fraction unit_model_data: - GasSpargedMembraneZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/gas_sparged_membrane_zo.py - unit_model_repositories: watertap/unit_models/zero_order/gas_sparged_membrane_zo.py - unit_models: GasSpargedMembraneZO + REEOxalateRoaster: https://github.com/prommis/prommis/tree/main/src/prommis/roasting/ree_oxalate_roaster + unit_model_repositories: prommis/roasting/ree_oxalate_roaster + unit_models: REEOxalateRoaster - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recTfjHHy0j8DD8Ws - name: Iron And Manganese Removal (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Ozone (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - IronManganeseRemovalZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/iron_and_manganese_removal_zo.py - unit_model_repositories: watertap/unit_models/zero_order/iron_and_manganese_removal_zo.py - unit_models: IronManganeseRemovalZO + OzoneZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/ozone_zo.py + unit_model_repositories: watertap/unit_models/zero_order/ozone_zo.py + unit_models: OzoneZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recU43fywlNwdVQNx - name: Pump (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Ozone with Advanced Oxidation Processes (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - PumpZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/pump_zo.py - unit_model_repositories: watertap/unit_models/zero_order/pump_zo.py - unit_models: PumpZO + OzoneAOPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/ozone_aop_zo.py + unit_model_repositories: watertap/unit_models/zero_order/ozone_aop_zo.py + unit_models: OzoneAOPZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recU8GBNd2deKmXGE - name: Energy Recovery (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Peracetic Acid Disinfection (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - EnergyRecoveryZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/energy_recovery_zo.py - unit_model_repositories: watertap/unit_models/zero_order/energy_recovery_zo.py - unit_models: EnergyRecoveryZO -- configurations: database, process_subtype, isothermal, isobaric - description: '' + PeraceticAcidDisinfection: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/peracetic_acid_disinfection_zo.py + unit_model_repositories: watertap/unit_models/zero_order/peracetic_acid_disinfection_zo.py + unit_models: PeraceticAcidDisinfection +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Library of common forms for phase equilibrium constraints. flowsheet_module: '' - id: recUUfsUQ0MSxt9jS - name: Dissolved Air Flotation (ZO) - project: WaterTAP + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'Phase equilibrium ' + project: IDAES property_package: '' - property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + property_package_repositories: idaes/models/properties/modular_properties/phase_equil/forms.py + property_packages: '' reaction_package: '' - unit_model_data: - DissolvedAirFlotationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/dissolved_air_flotation_zo.py - unit_model_repositories: watertap/unit_models/zero_order/dissolved_air_flotation_zo.py - unit_models: DissolvedAirFlotationZO + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recUxsryXeijZeLby - name: Integrated Anaerobic Membrane Bioreactor/Microbial Electrolysis Cell (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Photothermal Membrane (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - AnaerobicMBRMECZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/anaerobic_mbr_mec_zo.py - unit_model_repositories: watertap/unit_models/zero_order/anaerobic_mbr_mec_zo.py - unit_models: AnaerobicMBRMECZO -- configurations: database, process_subtype, isothermal, isobaric - description: '' + PhotothermalMembrane: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/photothermal_membrane_zo.py + unit_model_repositories: watertap/unit_models/zero_order/photothermal_membrane_zo.py + unit_models: PhotothermalMembrane +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES plug flow reactor model. flowsheet_module: '' - id: recVHEMMd8tRLlbb1 - name: Evaporation Pond (ZO) - project: WaterTAP + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Plug flow reactor + project: IDAES property_package: '' - property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock - - (Liq phase)' + property_package_repositories: '' + property_packages: '' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - EvaporationPondZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/evaporation_pond_zo.py - unit_model_repositories: watertap/unit_models/zero_order/evaporation_pond_zo.py - unit_models: EvaporationPondZO -- configurations: momentum_balance_type, has_pressure_change, energy_balance_type, - electroneutrality_ion, passing_species_list, default_passing_rejection, default_excluded_rejection - description: '' + PFR: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/plug_flow_reactor.py + unit_model_repositories: idaes/models/unit_models/plug_flow_reactor.py + unit_models: PFR +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: The Precipitator Unit Model represents an Equilibrium reactor unit + model with fi... flowsheet_module: '' - id: recWbhJodNieqNQmI - name: Nanofiltration (0D) - project: WaterTAP + full_description: The Precipitator Unit Model represents an Equilibrium reactor + unit model with fixed partition coefficients. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Precipitate + project: PrOMMiS property_package: '' property_package_data: - MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py - property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py - property_packages: MCASParameterBlock (Liq phase) + AqueousParameter (aqueous): https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_liquid_properties + prommis.precipitate.precipitate_solids_properties + PrecipitateParameters (precipitate).: https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_liquid_properties + prommis.precipitate.precipitate_solids_properties + property_package_repositories: prommis/precipitate/precipitate_liquid_properties + prommis.precipitate.precipitate_solids_properties + property_packages: AqueousParameter (aqueous); PrecipitateParameters (precipitate). reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e, temperature, - pressure, component molar flowrates), permeate pressure, solvent recovery fraction, - solute rejection fractions for all solutes except the one identified as the electroneutrality - species, membrane area, retentate pressure drop + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Aqueous inlet flowrate and concentrations, + percipitate temperature unit_model_data: - Nanofiltration0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/nanofiltration_0D.py - unit_model_repositories: watertap/unit_models/nanofiltration_0D.py - unit_models: Nanofiltration0D -- configurations: outlet_state_defined, has_phase_equilibrium, inlet_property_package, - inlet_property_package_args, outlet_property_package, outlet_property_package_args, - reaction_package, reaction_package_args - description: '' + Precipitator: https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitator + unit_model_repositories: prommis/precipitate/precipitator + unit_models: Precipitator +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES pressure changer model. flowsheet_module: '' - id: recXgFUQduoSd0pHB - inherited_model_(name,_unit_model): Translator - inherited_model_repository: idaes/models/unit_models/translator.py - name: ASM1 to ADM1 Translator - project: WaterTAP + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pressure changer + project: IDAES property_package: '' - property_package_data: - ? 'ASM1ParameterBlock - - ADM1ParameterBlock - - (Liq phase)' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - - watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' - property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - - watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' - property_packages: 'ASM1ParameterBlock - - ADM1ParameterBlock - - (Liq phase)' + property_package_repositories: '' + property_packages: '' reaction_package: '' - reaction_package_data: - ADM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py - reaction_package_repositories: watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py - reaction_packages: ADM1ReactionParameterBlock - specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, - pressure, volumetric flowrate, solute compositions, cations, anions). + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - Translator_ASM1_ADM1: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/translators/translator_asm1_adm1.py - unit_model_repositories: watertap/unit_models/translators/translator_asm1_adm1.py - unit_models: Translator_ASM1_ADM1 -- configurations: material_balance_type, energy_balance_type, momentum_balance_type, - concentration_polarization_type, mass_transfer_coefficient, transport_model, module_type, - has_pressure_change, pressure_change_type, friction_factor, area_definition, transformation_method, - transformation_scheme, finite_elements, collocation_points, has_full_reporting - control_volume_data: - MembraneChannel1DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/core/membrane_channel1d.py - control_volume_repositories: watertap/core/membrane_channel1d.py - control_volumes: MembraneChannel1DBlock + PressureChanger: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/pressure_changer.py + unit_model_repositories: idaes/models/unit_models/pressure_changer.py + unit_models: PressureChanger +- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, + has_leakage, has_mixing, pressure_exchange_calculation + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recYiwEaN2QT0vegV - inherited_model_(name,_unit_model): OsmoticallyAssistedReverseOsmosisBaseData - inherited_model_repository: watertap/unit_models/osmotically_assisted_reverse_osmosis_base.py - name: Osmotically Assisted Reverse Osmosis (1D) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pressure Exchanger project: WaterTAP property_package: '' property_package_data: - ? 'NaClParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py - property_package_repositories: watertap/property_models/NaCl_prop_pack.py - property_packages: 'NaClParameterBlock - - (Liq phase)' - reaction_package: '' - specifications_for_operating_conditions: 'Feed-side and permeate-side inlet state - variables (i.e, temperature, pressure, component mass flowrates), membrane area, - membrane water permeability A, membrane salt permeability B, structural parameter - (i.e., effective thickness). - - If concentration polarization effects, mass transfer coefficient, and pressure - drop are calculated: feed-side and permeate-side spacer porosity, channel height, - and feed-side Reynolds number or water mass recovery. + SeawaterParameterBlock MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: 'watertap/property_models/seawater_prop_pack.py - If has_pressure_change is set to True: pressure drop. + watertap/property_models/multicomp_aq_sol_prop_pack.py' + property_packages: 'SeawaterParameterBlock - If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: - concentration polarization modulus in feed and permeate channels. + MCASParameterBlock - If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: - mass transfer coefficient in feed and permeate channels. + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Feed-side and brine-side state variables + (i.e., temperature, pressure, volumetric flowrate, mass fraction), pressure exchanger + efficiency. - If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type - is not set to PressureChangeType.fixed_per_stage: membrane length and width. + If has_mixing is set to True: volumetric mixing fraction of the brine side and + feed side. - If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side - and permeate-side average pressure drop per unit length. + If has_leakage is set to True: volumetric leakage fraction of the brine side to + the feed side. - If pressure_change_type is set to PressureChangeType.calculated: friction factor, - feed-side and permeate-side velocity and pressure drop per unit length.' + If pressure_exchange_calculation configuration option is set to PressureExchangeType.high_pressure_difference: + high pressure difference, low pressure difference, and the pressure exchanger + efficiency is unfixed.' unit_model_data: - OsmoticallyAssistedReverseOsmosis1D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/osmotically_assisted_reverse_osmosis_1D.py - unit_model_repositories: watertap/unit_models/osmotically_assisted_reverse_osmosis_1D.py - unit_models: OsmoticallyAssistedReverseOsmosis1D + PressureExchanger: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_exchanger.py + unit_model_repositories: watertap/unit_models/pressure_exchanger.py + unit_models: PressureExchanger - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recZRaIYPdJRY0KMa - name: Sludge Tank (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Primary Separator (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - SludgeTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/sludge_tank_zo.py - unit_model_repositories: watertap/unit_models/zero_order/sludge_tank_zo.py - unit_models: SludgeTankZO -- configurations: has_pressure_change, pressure_drop_method, friction_factor_method, - hydraulic_diameter_method, operation_mode, limiting_current_density_method, limiting_current_density_data, - has_nonohmic_potential_membrane, has_Nernst_diffusion_layer, material_balance_type, - is_isothermal, energy_balance_type, momentum_balance_type + PrimarySeparatorZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/primary_separator_zo.py + unit_model_repositories: watertap/unit_models/zero_order/primary_separator_zo.py + unit_models: PrimarySeparatorZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES Product block. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Product + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Product: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/product.py + unit_model_repositories: idaes/models/unit_models/product.py + unit_models: Product +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Tool to interrogate IDAES flowsheets and list the physical properties + + required t...' + flowsheet_module: '' + full_description: 'Tool to interrogate IDAES flowsheets and list the physical properties + + required to simulate it.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Properties interrogator + project: IDAES + property_package: '' + property_package_data: + PropertyInterrogatorBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/interrogator/properties_interrogator.py + property_package_repositories: idaes/models/properties/interrogator/properties_interrogator.py + property_packages: PropertyInterrogatorBlock + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_phase_equilibrium, compressor, thermodynamic_assumption, support_isentropic_performance_curves, + isentropic_performance_curves, isentropic_performance_curves (build_callback, + build_head_expressions), variable_efficiency, bep_flow*, bep_eta*, flow_ratio*, + *When variable_efficiency is not VariableEfficiency.none + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recbtwAJEIcvfkgbn - name: Electrodialysis (0D) + inherited_model_(name,_unit_model): Pressure changer, PressureChanger -> Pump, Pump + inherited_model_repository: idaes/models/unit_models/pressure_changer.py + mandatory_config_options: '' + name: Pump project: WaterTAP property_package: '' property_package_data: - MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py - property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py - property_packages: MCASParameterBlock (Liq phase) + SeawaterParameterBlock MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: 'watertap/property_models/seawater_prop_pack.py + + watertap/property_models/multicomp_aq_sol_prop_pack.py' + property_packages: 'SeawaterParameterBlock + + MCASParameterBlock + + (Liq phase)' reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e. temperature, - pressure, component molar flowrates). Water transport number, water permeability, - voltage or current, electrode areal resistance, cell pair number, current utilization - coefficient, spacer thickness, membrane areal resistance, cell width, cell length, - thickness of ion exchange membranes, diffusivity of solute in the membrane phase, - transport number of ions in the membrane phase. + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Outlet pressure or pressure change across + the inlet and outlet, pump efficiency unit_model_data: - Electrodialysis0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/electrodialysis_0D.py - unit_model_repositories: watertap/unit_models/electrodialysis_0D.py - unit_models: Electrodialysis0D + Pump: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_changer.py + unit_model_repositories: watertap/unit_models/pressure_changer.py + unit_models: Pump +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Pump model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pump + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Pump: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/pressure_changer.py + unit_model_repositories: idaes/models/unit_models/pressure_changer.py + unit_models: Pump - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: reccIlKDkit6w9Mlc - name: Tri Media Filtration (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pump (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - TriMediaFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/tri_media_filtration_zo.py - unit_model_repositories: watertap/unit_models/zero_order/tri_media_filtration_zo.py - unit_models: TriMediaFiltrationZO + PumpZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/pump_zo.py + unit_model_repositories: watertap/unit_models/zero_order/pump_zo.py + unit_models: PumpZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: reccag575b0LRabc6 - name: Autothermal Hydrothermal Liquefaction (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pump Electricity (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - ATHTLZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/autothermal_hydrothermal_liquefaction_zo.py - unit_model_repositories: watertap/unit_models/zero_order/autothermal_hydrothermal_liquefaction_zo.py - unit_models: ATHTLZO -- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, - has_leakage, has_mixing, pressure_exchange_calculation + PumpElectricityZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/pump_electricity_zo.py + unit_model_repositories: watertap/unit_models/zero_order/pump_electricity_zo.py + unit_models: PumpElectricityZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Method for constant relative permittivity. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pure component electrolyte methods + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/pure/electrolyte.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Pure component gas viscosities at low pressures from critical properties, + + acentr...' + flowsheet_module: '' + full_description: 'Pure component gas viscosities at low pressures from critical + properties, + + acentric factor, and dipole moment.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pure component gas viscosities at low pressures + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/pure/ChungPure.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Methods for calculating pure component properties from: The Properties + of Gases ...' + flowsheet_module: '' + full_description: 'Methods for calculating pure component properties from: The Properties + of Gases & Liquids, 4th Edition Reid, Prausnitz and Polling, 1987, McGraw-Hill.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pure component properties + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/pure/RPP4.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Methods for calculating pure component properties from: The Properties + of Gases ...' + flowsheet_module: '' + full_description: 'Methods for calculating pure component properties from: The Properties + of Gases & Liquids, 3rd Edition Reid, Prausnitz and Polling, 1977, McGraw-Hill.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pure component properties + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/pure/RPP3.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Methods for calculating pure component properties from: Perry''s Chemical + Enginee...' + flowsheet_module: '' + full_description: 'Methods for calculating pure component properties from: Perry''s + Chemical Engineers'' Handbook.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pure component properties + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/pure/Perrys.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Pure component properties as used by the NIST WebBook. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pure component properties + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/pure/NIST.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 'Methods for calculating pure component properties from: The Properties + of Gases ...' + flowsheet_module: '' + full_description: 'Methods for calculating pure component properties from: The Properties + of Gases & Liquids, 5th Edition Reid, Prausnitz and Polling, 2001, McGraw-Hill.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Pure component properties + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/pure/RPP5.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Methods for calculating equilibrium constants. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Reaction equilibrium constants + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: idaes/models/properties/modular_properties/reactions/equilibrium_constant.py + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Methods for calculating rate constants. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Reaction rate constants + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: idaes/models/properties/modular_properties/reactions/rate_constant.py + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Methods for defining reaction rates. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Reaction rates + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: idaes/models/properties/modular_properties/reactions/rate_forms.py + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Tool to interrogate IDAES flowsheets and list the reaction properties + required t... + flowsheet_module: '' + full_description: Tool to interrogate IDAES flowsheets and list the reaction properties + required to simulate it. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Reactions interrogator + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_data: + ReactionInterrogatorBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/interrogator/reactions_interrogator.py + reaction_package_repositories: idaes/models/properties/interrogator/reactions_interrogator.py + reaction_packages: ReactionInterrogatorBlock + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recd1rSMfyI2gw9lq - name: Pressure Exchanger + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Recirculating Dynamic Membrane Bioreactor (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'SeawaterParameterBlock + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + DMBRZOO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/dmbr_zo.py + unit_model_repositories: watertap/unit_models/zero_order/dmbr_zo.py + unit_models: DMBRZOO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: The University of Kentucky (UKy) rare earth element (REE) processing + plant is de... + flowsheet_module: prommis/uky/uky_flowsheet.py + full_description: 'The University of Kentucky (UKy) rare earth element (REE) processing + plant is designed to extract salable rare earth oxides from domestic U.S. coal + and coal byproducts. While this implementation of the plant does not take into + account - MCASParameterBlock + all of the complexities and unit processes detailed in the 2019 report, it depicts + the major phenomena by utilizing a series of conventional REE extraction techniques, + including acid tank leaching, solvent extraction, precipitation, and product roasting.' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: ' CoalRefuseParameters (solid)' + name: REE processing plant + project: PrOMMiS + property_package: '' + property_package_data: + AqueousParameter (aqueous): https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_liquid_properties + CoalRefuseParameters (solid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solution_properties + GenericParameterBlock (gas): https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/modular_properties/base/generic_property + LeachSolutionParameters (liquid): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solids_properties + PrecipitateParameters (precipitate): https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitate_solids_properties + REESolExOgParameters (organic): https://github.com/prommis/prommis/tree/main/src/prommis/solvent_extraction/ree_og_distribution + property_package_repositories: 'prommis/leaching/leach_solids_properties; - (Liq phase)' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/seawater_prop_pack.py + prommis/leaching/leach_solution_properties; - watertap/property_models/multicomp_aq_sol_prop_pack.py' - property_package_repositories: 'watertap/property_models/seawater_prop_pack.py + prommis/precipitate/precipitate_liquid_properties; - watertap/property_models/multicomp_aq_sol_prop_pack.py' - property_packages: 'SeawaterParameterBlock + prommis/precipitate/precipitate_solids_properties; - MCASParameterBlock + prommis/solvent_extraction/ree_og_distribution; - (Liq phase)' + idaes/models/properties/modular_properties/base/generic_property' + property_packages: LeachSolutionParameters (liquid); CoalRefuseParameters (solid); + AqueousParameter (aqueous); PrecipitateParameters (precipitate); REESolExOgParameters + (organic); GenericParameterBlock (gas) reaction_package: '' - specifications_for_operating_conditions: 'Feed-side and brine-side state variables - (i.e., temperature, pressure, volumetric flowrate, mass fraction), pressure exchanger - efficiency. + reaction_package_data: + CoalRefuseLeachingReactions: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_reactions + reaction_package_repositories: prommis/leaching/leach_reactions + reaction_packages: CoalRefuseLeachingReactions + specifications_for_operating_conditions: Leach liquid inlet flowrate and concentrations, + leach solid inlet mass flowrateand fractions, leach volume; rougher makeup stream + flowrate and concentrations; acid feeds (3) flowrate and concentrations; cleaner + make-up stream flowrate and concentrations; separators split fraction; sl separators + liquid recovery; precipitate temperature; roaster pressure drop, roaster gas inlet + temperature, pressure, mole flowrate and fraction, roaster gas outlet temperature, + roaster recovery fraction + unit_model_data: + LeachingTrain: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_train + Mixer: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/mixer + Precipitator: https://github.com/prommis/prommis/tree/main/src/prommis/precipitate/precipitator + REEOxalateRoaster: https://github.com/prommis/prommis/tree/main/src/prommis/roasting/ree_oxalate_roaster + SLSeparator: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/solid_liquid + Separator: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/separator + SolventExtraction: https://github.com/prommis/prommis/tree/main/src/prommis/solvent_extraction/solvent_extraction + unit_model_repositories: 'prommis/leaching/leach_train; - If has_mixing is set to True: volumetric mixing fraction of the brine side and - feed side. + prommis/precipitate/precipitator; - If has_leakage is set to True: volumetric leakage fraction of the brine side to - the feed side. + prommis/roasting/ree_oxalate_roaster; - If pressure_exchange_calculation configuration option is set to PressureExchangeType.high_pressure_difference: - high pressure difference, low pressure difference, and the pressure exchanger - efficiency is unfixed.' - unit_model_data: - PressureExchanger: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/pressure_exchanger.py - unit_model_repositories: watertap/unit_models/pressure_exchanger.py - unit_models: PressureExchanger -- configurations: database, process_subtype, isothermal, isobaric + prommis/solvent_extraction/solvent_extraction; + + idaes/models/unit_models/solid_liquid; + + idaes/models/unit_models/mixer; + + idaes/models/unit_models/separator' + unit_models: LeachingTrain; Precipitator; REEOxalateRoaster; SolventExtraction; + SLSeparator; Mixer;Separator +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + concentration_polarization_type, mass_transfer_coefficient, transport_model, module_type, + has_pressure_change, pressure_change_type, friction_factor, has_full_reporting + control_volume_data: + MembraneChannel0DBlock: https://github.com/watertap-org/watertap/tree/main/watertap/core/membrane_channel0d.py + control_volume_repositories: watertap/core/membrane_channel0d.py + control_volumes: MembraneChannel0DBlock description: '' flowsheet_module: '' - id: recdUIIOeMT57QM0v - name: Struvite Classifier (ZO) + inherited_model_(name,_unit_model): ReverseOsmosisBaseData + inherited_model_repository: watertap/unit_models/reverse_osmosis_base.py + mandatory_config_options: '' + name: Reverse Osmosis (0D) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + NaClParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py + property_package_repositories: watertap/property_models/NaCl_prop_pack.py + property_packages: 'NaClParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet feed state variables (i.e., temperature, + pressure, component flowrates), membrane area, membrane water permeability A, + membrane salt permeability B, and permeate pressure. + + If concentration polarization effects, mass transfer coefficient, and pressure + drop are calculated: feed spacer porosity, feed channel height, and membrane length + or membrane width or inlet Reynolds number. + + If has_pressure_change is set to True: pressure drop. + + If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: + concentration polarization modulus in feed channel. + + If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: + mass transfer coefficient in feed channel. - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py - property_package_repositories: watertap/property_models/water_prop_pack.py - property_packages: 'WaterParameterBlock + If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type + is set to PressureChangeType.calculated: feed channel height, hydraulic diameter, + spacer porosity, Reynolds number. - (Liq phase)' - reaction_package: '' + If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type + is not set to PressureChangeType.fixed_per_stage: membrane length and width. + + If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side + average pressure drop per unit length. + + If pressure_change_type is set to PressureChangeType.calculated: friction factor, + feed-side velocity, and pressure drop per unit length. + + If transport_model is set to TransportModel.SKK (Speigler-Kedem-Katchalsky model): + reflection coefficient, alpha.' unit_model_data: - StruviteClassifierZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/struvite_classifier_zo.py - unit_model_repositories: watertap/unit_models/zero_order/struvite_classifier_zo.py - unit_models: StruviteClassifierZO + ReverseOsmosis0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/reverse_osmosis_0D.py + unit_model_repositories: watertap/unit_models/reverse_osmosis_0D.py + unit_models: ReverseOsmosis0D - configurations: material_balance_type, energy_balance_type, momentum_balance_type, concentration_polarization_type, mass_transfer_coefficient, transport_model, module_type, has_pressure_change, pressure_change_type, friction_factor, area_definition, transformation_method, @@ -2205,22 +4879,21 @@ models: control_volumes: MembraneChannel0DBlock description: '' flowsheet_module: '' - id: recdWg0rYbOtRLDdB inherited_model_(name,_unit_model): ReverseOsmosisBaseData inherited_model_repository: watertap/unit_models/reverse_osmosis_base.py + mandatory_config_options: '' name: Reverse Osmosis (1D) project: WaterTAP property_package: '' property_package_data: - ? 'NaClParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py + NaClParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/NaCl_prop_pack.py property_package_repositories: watertap/property_models/NaCl_prop_pack.py property_packages: 'NaClParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' specifications_for_operating_conditions: 'Inlet feed state variables (i.e., temperature, pressure, component flowrates), membrane area, membrane water permeability A, membrane salt permeability B, permeate pressure, and membrane area or length or @@ -2257,74 +4930,472 @@ models: ReverseOsmosis1D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/reverse_osmosis_1D.py unit_model_repositories: watertap/unit_models/reverse_osmosis_1D.py unit_models: ReverseOsmosis1D -- configurations: outlet_state_defined, has_phase_equilibrium, inlet_property_package, - inlet_property_package_args, outlet_property_package, outlet_property_package_args, - bio_P, inlet_reaction_package, inlet_reaction_package_args, outlet_reaction_package, - outlet_reaction_package_args +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Example property package for the saponification of Ethyl Acetate with + NaOH. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Saponification reactions + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_data: + SaponificationReactionParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_reactions.py + reaction_package_repositories: idaes/models/properties/examples/saponification_reactions.py + reaction_packages: SaponificationReactionParameterBlock + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Example property package for the saponification of Ethyl Acetate with + NaOH (simp... + flowsheet_module: '' + full_description: Example property package for the saponification of Ethyl Acetate + with NaOH (simple liquid phase properties). + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Saponification thermo + project: IDAES + property_package: '' + property_package_data: + SaponificationParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_thermo.py + property_package_repositories: idaes/models/properties/examples/saponification_thermo.py + property_packages: SaponificationParameterBlock + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: receCYtfkMMSNmk9K - inherited_model_(name,_unit_model): Translator - inherited_model_repository: idaes/models/unit_models/translator.py - name: ASM2d to ADM1 Translator + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Screen (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'ModifiedADM1ParameterBlock + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - ModifiedASM2dParameterBlock' - : 'https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ScreenZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/screen_zo.py + unit_model_repositories: watertap/unit_models/zero_order/screen_zo.py + unit_models: ScreenZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Seawater Onshore Intake (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py' - property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + SWOnshoreIntakeZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/sw_onshore_intake_zo.py + unit_model_repositories: watertap/unit_models/zero_order/sw_onshore_intake_zo.py + unit_models: SWOnshoreIntakeZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Secondary Wastewater Treatment Plant (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py' - property_packages: 'ModifiedADM1ParameterBlock + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + SecondaryTreatmentWWTPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/secondary_treatment_wwtp_zo.py + unit_model_repositories: watertap/unit_models/zero_order/secondary_treatment_wwtp_zo.py + unit_models: SecondaryTreatmentWWTPZO +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Sedimentation (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - ModifiedASM2dParameterBlock' + (Liq phase)' reaction_package: '' - reaction_package_data: - ModifiedADM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py - ModifiedASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py - reaction_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py; + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + SedimentationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/sedimentation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/sedimentation_zo.py + unit_models: SedimentationZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: General purpose separator block for IDAES models. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Separator + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Separator: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/separator.py + unit_model_repositories: idaes/models/unit_models/separator.py + unit_models: Separator +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Settling Pond (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py' - reaction_packages: 'ModifiedADM1ReactionParameterBlock; + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + SettlingPondZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/settling_pond_zo.py + unit_model_repositories: watertap/unit_models/zero_order/settling_pond_zo.py + unit_models: SettlingPondZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: 1D Single pass shell and tube HX model with 0D wall conduction model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Shell and tube heat exchanger + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + ShellAndTube1D: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/shell_and_tube_1d.py + unit_model_repositories: idaes/models/unit_models/shell_and_tube_1d.py + unit_models: ShellAndTube1D +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Skeleton unit model that provides users with a generic skeleton to + add a custom ... + flowsheet_module: '' + full_description: Skeleton unit model that provides users with a generic skeleton + to add a custom or a surrogate unit model when control volumes are not required. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Skeleton model + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + SkeletonUnitModel: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/skeleton_model.py + unit_model_repositories: idaes/models/unit_models/skeleton_model.py + unit_models: SkeletonUnitModel +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Sludge Tank (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - ModifiedASM2dReactionParameterBlock' - specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, - pressure, volumetric flowrate, solute compositions). + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - Translator_ASM2d_ADM1: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/translators/translator_asm2d_adm1.py - unit_model_repositories: watertap/unit_models/translators/translator_asm2d_adm1.py - unit_models: Translator_ASM2d_ADM1 + SludgeTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/sludge_tank_zo.py + unit_model_repositories: watertap/unit_models/zero_order/sludge_tank_zo.py + unit_models: SludgeTankZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: receD8lZuEoF6O7uw - name: Ion Exchange (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: SMP (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + SMPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/smp_zo.py + unit_model_repositories: watertap/unit_models/zero_order/smp_zo.py + unit_models: SMPZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Base model for solid-liquid separations. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Solid-liquid separator + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + SLSeparator: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/solid_liquid + /sl_separator.py + unit_model_repositories: 'idaes/models/unit_models/solid_liquid + + /sl_separator.py' + unit_models: SLSeparator +- configurations: number_of_finite_elements + control_volume_repositories: '' + control_volumes: '' + description: The Solvent Extraction unit model is used to perform the solvent extraction + unit... + flowsheet_module: '' + full_description: The Solvent Extraction unit model is used to perform the solvent + extraction unit operation. It represents a series of tanks, referred to as stages, + through which the aqueous and organic phases are passed, and the desired components + are extracted subsequently. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Solvent extraction + project: PrOMMiS + property_package: '' + property_package_data: + LeachSolutionParameters (aqueous): https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solids_properties + prommis.solvent_extraction.ree_og_distribution + REESolExOgParameters (organic).: https://github.com/prommis/prommis/tree/main/src/prommis/leaching/leach_solids_properties + prommis.solvent_extraction.ree_og_distribution + property_package_repositories: prommis/leaching/leach_solids_properties prommis.solvent_extraction.ree_og_distribution + property_packages: LeachSolutionParameters (aqueous); REESolExOgParameters (organic). + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Aqueous inlet flowrate and concentrations, + solid inlet mass flowrate and concentrations + unit_model_data: + SolventExtraction: https://github.com/prommis/prommis/tree/main/src/prommis/solvent_extraction/solvent_extraction + unit_model_repositories: prommis/solvent_extraction/solvent_extraction + unit_models: SolventExtraction +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: A smooth, square flash formulation for equation-oriented flowsheet + optimization. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Square flash formulation + project: IDAES + property_package: '' + property_package_repositories: idaes/models/properties/modular_properties/phase_equil/smooth_VLE.py + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_repositories: '' + unit_models: '' +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES StateJunction model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: 'State junction ' + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + StateJunction: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/statejunction.py + unit_model_repositories: idaes/models/unit_models/statejunction.py + unit_models: StateJunction +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Static Mixer (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - IonExchangeZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/ion_exchange_zo.py - unit_model_repositories: watertap/unit_models/zero_order/ion_exchange_zo.py - unit_models: IonExchangeZO -- configurations: material_balance_type, is_isothermal, energy_balance_type, momentum_balance_type, - has_pressure_change + StaticMixerZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/static_mixer_zo.py + unit_model_repositories: watertap/unit_models/zero_order/static_mixer_zo.py + unit_models: StaticMixerZO +- configurations: material_balance_type, energy_balance_type, momentum_balance_type + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recewsjrFbayzhTup - name: Nanofiltration (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Steam Jet Ejector + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + vap phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: WaterParameterBlock (Liq phase, vap phase) + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet state variables (i.e., temperature, + pressure, and component flowrates for motive steam and entrained vapor). Entrainment + ratio, compression ratio. + unit_model_data: + SteamEjector: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/steam_ejector.py + unit_model_repositories: watertap/unit_models/steam_ejector.py + unit_models: SteamEjector +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Standard IDAES STOICHIOMETRIC reactor model + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Stoichiometric reactor + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + StoichiometricReactor: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/stoichiometric_reactor.py + unit_model_repositories: idaes/models/unit_models/stoichiometric_reactor.py + unit_models: StoichiometricReactor +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_pressure_change, reagent, precipitate + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Stoichiometric reactor project: WaterTAP property_package: '' property_package_data: @@ -2332,670 +5403,765 @@ models: property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py property_packages: MCASParameterBlock (Liq phase) reaction_package: '' - specifications_for_operating_conditions: Inlet feed state variables (i.e, temperature, - pressure, solvent and solute mass flowrates). Membrane's solvent volumetric flux - rate, permeate pressure, membrane's solute rejection. If solutes are ionic and - contain multiple ion pairs, one ion's rejection may be unfixed for electroneutrality. - Another variable, such as volumetric recovery rate or membrane area, fixes the - last degree of freedom. + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet state variables (i.e., temperature, + pressure, component mass compositions). If reagents are supplied: reagent mass + flow rate or reagent dose. If precipitants are supplied: precipitant mass flow + rate, mass fraction of solids in precipitant (solid) waste stream.' + unit_model_data: + StoichiometricReactor: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/stoichiometric_reactor.py + unit_model_repositories: watertap/unit_models/stoichiometric_reactor.py + unit_models: StoichiometricReactor +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Storage Tank (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock + + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + StorageTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/storage_tank_zo.py + unit_model_repositories: watertap/unit_models/zero_order/storage_tank_zo.py + unit_models: StorageTankZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Unit model to adjust size of streams to represent, for example, a stream + being s... + flowsheet_module: '' + full_description: Unit model to adjust size of streams to represent, for example, + a stream being split across several identical units, which are then all modeled + as a single IDAES unit. + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Stream scaler + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - NanofiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/nanofiltration_ZO.py - unit_model_repositories: watertap/unit_models/nanofiltration_ZO.py - unit_models: NanofiltrationZO + StreamScaler: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/stream_scaler.py + unit_model_repositories: idaes/models/unit_models/stream_scaler.py + unit_models: StreamScaler - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recfIwyfG9WIQvhs3 - name: Clarifier (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Struvite Classifier (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - ClarifierZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/clarifier_zo.py - unit_model_repositories: watertap/unit_models/zero_order/clarifier_zo.py - unit_models: ClarifierZO + StruviteClassifierZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/struvite_classifier_zo.py + unit_model_repositories: watertap/unit_models/zero_order/struvite_classifier_zo.py + unit_models: StruviteClassifierZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recfo1H40pvG9eGo6 - name: Walnut Shell Filter (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Suboxic Activated Sludge Process (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - WalnutShellFilterZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/walnut_shell_filter_zo.py - unit_model_repositories: watertap/unit_models/zero_order/walnut_shell_filter_zo.py - unit_models: WalnutShellFilterZO + SuboxicASMZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/suboxic_activated_sludge_process_zo.py + unit_model_repositories: watertap/unit_models/zero_order/suboxic_activated_sludge_process_zo.py + unit_models: SuboxicASMZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rechBQ9ZVVVCbdwy3 - name: Secondary Wastewater Treatment Plant (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Supercritical Salt Precipitation (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - SecondaryTreatmentWWTPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/secondary_treatment_wwtp_zo.py - unit_model_repositories: watertap/unit_models/zero_order/secondary_treatment_wwtp_zo.py - unit_models: SecondaryTreatmentWWTPZO + SaltPrecipitationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/supercritical_salt_precipitation_zo.py + unit_model_repositories: watertap/unit_models/zero_order/supercritical_salt_precipitation_zo.py + unit_models: SaltPrecipitationZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rechJ3MQVSi5xBLd1 - name: Deep Well Injection (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Surface Discharge (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - DeepWellInjectionZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/deep_well_injection_zo.py - unit_model_repositories: watertap/unit_models/zero_order/deep_well_injection_zo.py - unit_models: DeepWellInjectionZO -- configurations: material_balance_type, energy_balance_type, momentum_balance_type, - has_heat_transfer, has_pressure_change, has_equilibrium_reactions, has_phase_equilibrium, - has_heat_of_reaction, reaction_package, reaction_package_args, electricity_consumption, - has_aeration + SurfaceDischarge: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/surface_discharge_zo.py + unit_model_repositories: watertap/unit_models/zero_order/surface_discharge_zo.py + unit_models: SurfaceDischarge +- configurations: outlet_list, num_outlets (not used if outlet_list arg is provided), + split_basis, material_balance_type, momentum_balance_type, has_phase_equilibrium, + energy_split_basis, ideal_separation, ideal_split_map, mixed_state_block, construct_ports, + activated_sludge_model + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rechOYrbR9I8SNt6N - name: Continuously Stirred Tank Reactor with Injection + inherited_model_(name,_unit_model): Separator, Separator + inherited_model_repository: idaes/models/unit_models/separator.py + mandatory_config_options: '' + name: Thickener project: WaterTAP property_package: '' property_package_data: - ? 'SaponificationParameterBlock - - ASM1ParameterBlock - - ASM2dParameterBlock - - ModifiedASM2dParameterBlock - - ADM1ParameterBlock' - : 'https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_thermo.py - - watertap/property_models/unit_specific/activated_sludge/asm1_properties.py - + ASM1ParameterBlock ASM2dParameterBlock ModifiedASM2dParameterBlock (Single Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_properties.py watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' - property_package_repositories: 'idaes/models/properties/examples/saponification_thermo.py - - watertap/property_models/unit_specific/activated_sludge/asm1_properties.py + property_package_repositories: 'watertap/property_models/unit_specific/activated_sludge/asm1_properties.py watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py - - watertap/property_models/unit_specific/activated_sludge/adm1_properties.py' - property_packages: 'SaponificationParameterBlock - - ASM1ParameterBlock + watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py' + property_packages: 'ASM1ParameterBlock ASM2dParameterBlock ModifiedASM2dParameterBlock - ADM1ParameterBlock' + (Single Liq phase)' reaction_package: '' - reaction_package_data: - ADM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py - ASM1ReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py - ASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py - ModifiedASM2dReactionParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py - SaponificationReactionParameterBlock: https://github.com/idaes/idaes-pse/tree/main/idaes/models/properties/examples/saponification_reactions.py - reaction_package_repositories: 'idaes/models/properties/examples/saponification_reactions.py; - - watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py; - - watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py; - - watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py; - - watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py' - reaction_packages: 'SaponificationReactionParameterBlock; - - ASM1ReactionParameterBlock; - - ASM2dReactionParameterBlock; - - ModifiedASM2dReactionParameterBlock; - - ADM1ReactionParameterBlock' - specifications_for_operating_conditions: 'Inlet feed state variables (i.e. temperature, - pressure, component flowrates), volume or hydraulic retention time, injection - rates for all components, heat duty if heat transfer is included, change in pressure - if pressure change is included. If aeration is included, the following degrees - of freedom could replace the oxygen injection rate: lumped mass transfer coefficient - for oxygen, dissolved oxygen concentration at equilibrium.' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: Inlet feed state variables (i.e., temperature, + pressure, component mass compositions, alkalinity, volumetric flowrate). unit_model_data: - CSTR_Injection: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/cstr_injection.py - unit_model_repositories: watertap/unit_models/cstr_injection.py - unit_models: CSTR_Injection + Thickener: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/thickener.py + unit_model_repositories: watertap/unit_models/thickener.py + unit_models: Thickener +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Thickener unit model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Thickener + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Thickener0D: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/solid_liquid + /thickener.py + unit_model_repositories: 'idaes/models/unit_models/solid_liquid + + /thickener.py' + unit_models: Thickener0D - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rechRK3Zny8Z5Y1Lf - name: High-Rate Contact Stabilization (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Tramp Oil Tank (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - HRCSZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/hrcs_zo.py - unit_model_repositories: watertap/unit_models/zero_order/hrcs_zo.py - unit_models: HRCSZO + TrampOilTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/tramp_oil_tank_zo.py + unit_model_repositories: watertap/unit_models/zero_order/tramp_oil_tank_zo.py + unit_models: TrampOilTankZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Generic template for a translator block. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Translator + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Translator: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/translator.py + unit_model_repositories: idaes/models/unit_models/translator.py + unit_models: Translator - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rechbVnG5xWXmz0dr - name: Suboxic Activated Sludge Process (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Tri Media Filtration (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - SuboxicASMZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/suboxic_activated_sludge_process_zo.py - unit_model_repositories: watertap/unit_models/zero_order/suboxic_activated_sludge_process_zo.py - unit_models: SuboxicASMZO + TriMediaFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/tri_media_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/tri_media_filtration_zo.py + unit_models: TriMediaFiltrationZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Isentropic turbine model. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Turbine + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Turbine: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/pressure_changer.py + unit_model_repositories: idaes/models/unit_models/pressure_changer.py + unit_models: Turbine - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: rechcJjTDdQlyNGWT - name: Intrusion Mitigation (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Ultra Filtration (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - IntrusionMitigationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/intrusion_mitigation_zo.py - unit_model_repositories: watertap/unit_models/zero_order/intrusion_mitigation_zo.py - unit_models: IntrusionMitigationZO -- configurations: database, process_subtype, isothermal, isobaric + UltraFiltrationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/ultra_filtration_zo.py + unit_model_repositories: watertap/unit_models/zero_order/ultra_filtration_zo.py + unit_models: UltraFiltrationZO +- configurations: material_balance_type, energy_balance_type, momentum_balance_type, + has_pressure_change, uv_dose_type, has_aop, target_species + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: reciRQU5Ejsiup157 - name: Injection Well Disposal (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Ultraviolet Advanced Oxidation Process project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + NDMAParameterBlock MCASParameterBlock: https://github.com/watertap-org/watertap/tree/main/watertap/property_models/unit_specific/NDMA_prop_pack.py + watertap/property_models/multicomp_aq_sol_prop_pack.py + property_package_repositories: 'watertap/property_models/unit_specific/NDMA_prop_pack.py + + watertap/property_models/multicomp_aq_sol_prop_pack.py' + property_packages: 'NDMAParameterBlock + + MCASParameterBlock' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: 'Inlet feed state variables (i.e., temperature, + pressure, component mass flowrates). + + If the uv_dose_type configuration option is set to default UVDoseType.fixed and + the has_aop configuration is set to default False (5 DOF): Inactivation rate coefficient + or overall pseudo-first order rate constant; two variables out of UV dose, average + intensity of UV light, exposure time of UV light; either electricity demand of + components with phase or electrical efficiency; and lamp efficiency. + + Pseudo-first order rate constant for indirect photolysis of component is fixed + to 0 when has_aop configuration is set to default False. - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + If the uv_dose_type configuration option to UVDoseType.calculated (7 additional + DOF, 12 DOF in total): UV transmittance; coefficients A, B, C , D; relative lamp + output; number of banks. + + If has_aop is set to True (2 additional DOF, 7 DOF in total): second-order reaction + rate constant; steady-state concentration of hydrogen peroxide.' + unit_model_data: + Ultraviolet0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/uv_aop.py + unit_model_repositories: watertap/unit_models/uv_aop.py + unit_models: Ultraviolet0D +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: UV Reactor (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - InjectionWellDisposalZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/injection_well_disposal_zo.py - unit_model_repositories: watertap/unit_models/zero_order/injection_well_disposal_zo.py - unit_models: InjectionWellDisposalZO + UVZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/uv_zo.py + unit_model_repositories: watertap/unit_models/zero_order/uv_zo.py + unit_models: UVZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: reciolQu5toteJra5 - name: Decarbonator (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: UV with Advanced Oxidation Processes (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - DecarbonatorZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/decarbonator_zo.py - unit_model_repositories: watertap/unit_models/zero_order/decarbonator_zo.py - unit_models: DecarbonatorZO -- configurations: material_balance_type, energy_balance_type, momentum_balance_type, - target_ion, regenerant, hazardous_waste, isotherm + UVAOPZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/uv_aop_zo.py + unit_model_repositories: watertap/unit_models/zero_order/uv_aop_zo.py + unit_models: UVAOPZO +- configurations: '' + control_volume_repositories: '' + control_volumes: '' + description: Standard valve models for adiabatic control valves. + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Valve + project: IDAES + property_package: '' + property_package_repositories: '' + property_packages: '' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + Valve: https://github.com/idaes/idaes-pse/tree/main/idaes/models/unit_models/valve.py + unit_model_repositories: idaes/models/unit_models/valve.py + unit_models: Valve +- configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recj0Bj9UU8XnynsA - name: Ion Exchange (0D) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Volatile Fatty Acid (VFA) Recovery Unit (ZO) project: WaterTAP property_package: '' property_package_data: - MCASParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/multicomp_aq_sol_prop_pack.py - property_package_repositories: watertap/property_models/multicomp_aq_sol_prop_pack.py - property_packages: MCASParameterBlock (Liq phase) - reaction_package: '' - specifications_for_operating_conditions: 'Inlet feed state variables (temperature, - pressure, component molar flowrate), resin bead diameter, resin bulk density, - bed porosity, service flow rate or superficial velocity through bed, number of - operational columns. - - If isotherm is set to langmuir: Langmuir isotherm coefficient, resin maximum capacity, - dimensionless time. + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - If isotherm is set to freundlich: Freundlich isotherm exponent, bed volumes of - feed at breakthru concentration, dimensionless (relative) concentration of target - ion, bed volumes of feed at 50 percent breakthrough or mass transfer coefficient - for Clark model (kT).' + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - IonExchange0D: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/ion_exchange_0D.py - unit_model_repositories: watertap/unit_models/ion_exchange_0D.py - unit_models: IonExchange0D + VFARecoveryZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/vfa_recovery_zo.py + unit_model_repositories: watertap/unit_models/zero_order/vfa_recovery_zo.py + unit_models: VFARecoveryZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recjAU2fbhrUeFYeU - name: Storage Tank (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Walnut Shell Filter (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + property_package_repositories: watertap/property_models/water_prop_pack.py + property_packages: 'WaterParameterBlock - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + (Liq phase)' + reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' + unit_model_data: + WalnutShellFilterZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/walnut_shell_filter_zo.py + unit_model_repositories: watertap/unit_models/zero_order/walnut_shell_filter_zo.py + unit_models: WalnutShellFilterZO +- configurations: database, process_subtype, isothermal, isobaric, fix_pump_power + control_volume_repositories: '' + control_volumes: '' + description: '' + flowsheet_module: '' + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Water Pumping Station (ZO) + project: WaterTAP + property_package: '' + property_package_data: + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - StorageTankZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/storage_tank_zo.py - unit_model_repositories: watertap/unit_models/zero_order/storage_tank_zo.py - unit_models: StorageTankZO + WaterPumpingStationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/water_pumping_station_zo.py + unit_model_repositories: watertap/unit_models/zero_order/water_pumping_station_zo.py + unit_models: WaterPumpingStationZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recjDzt0RwNcMP9Kn - name: UV Reactor (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Well Field (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - UVZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/uv_zo.py - unit_model_repositories: watertap/unit_models/zero_order/uv_zo.py - unit_models: UVZO + WellFieldZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/well_field_zo.py + unit_model_repositories: watertap/unit_models/zero_order/well_field_zo.py + unit_models: WellFieldZO - configurations: database, process_subtype, isothermal, isobaric + control_volume_repositories: '' + control_volumes: '' description: '' flowsheet_module: '' - id: recjE2AmkvqTp7c1n - name: Air Flotation (ZO) + inherited_model_(name,_unit_model): '' + inherited_model_repository: '' + mandatory_config_options: '' + name: Wind-Aided Intensified Evaporation Unit (ZO) project: WaterTAP property_package: '' property_package_data: - ? 'WaterParameterBlock - - (Liq phase)' - : https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py + WaterParameterBlock (Liq phase): https://github.com/watertap-org/watertap/tree/main/watertap/property_models/water_prop_pack.py property_package_repositories: watertap/property_models/water_prop_pack.py property_packages: 'WaterParameterBlock (Liq phase)' reaction_package: '' + reaction_package_repositories: '' + reaction_packages: '' + specifications_for_operating_conditions: '' unit_model_data: - AirFlotationZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/air_flotation_zo.py - unit_model_repositories: watertap/unit_models/zero_order/air_flotation_zo.py - unit_models: AirFlotationZO + WAIVZO: https://github.com/watertap-org/watertap/tree/main/watertap/unit_models/zero_order/waiv_zo.py + unit_model_repositories: watertap/unit_models/zero_order/waiv_zo.py + unit_models: WAIVZO products: - code: + conda-forge: pyomo + github: Pyomo/pyomo + pypi: pyomo + description: Pyomo is an open-source Python package for modeling and solving equation-oriented + optimization problems, enabling users to define variables, constraints, and objectives + and solve them using various solvers, including LP, NLP, and MILP. + interface: Python API + links: '' + name: Pyomo + projects: '' +- code: + conda-forge: '' + github: CCSI-Toolset/FOQUS + pypi: ccsi-foqus + description: Framework for Optimization and Uncertainty Quantification + interface: Graphical (GUI) + links: '' + name: FOQUS + projects: CCSI2 +- code: + conda-forge: idaes-pse + github: IDAES/idaes-pse + pypi: idaes-pse + description: IDAES core Python framework and model library + interface: Python API + links: '' + name: IDAES-PSE + projects: IDAES +- code: + conda-forge: '' + github: watertap-org/watertap + pypi: watertap + description: WaterTAP core model library + interface: Python API + links: '' + name: WaterTAP + projects: WaterTAP +- code: + conda-forge: '' github: watertap-org/parameter-sweep pypi: parameter-sweep description: Toolkit to solve Pyomo models multiple times with different values for parameters, optionally in parallel - id: recSKlnunMYP1HZIh interface: Python API + links: '' name: Parameter Sweep - projects: - - recCwLQQYPhrvmypf - - reciZ8S487CQTeWr0 -- code: {} - description: Self-contained, one-click-installer graphical application for interacting - with IDAES flowsheets - id: recThdJTFwvbxTVci - interface: Graphical (GUI) - name: IDAES Flowsheet UI - projects: - - recKkXobkOB85kvR3 - - recsrajWweFWzVZkj -- code: - github: prommis/idaes-flowsheet-processor-ui - description: Graphical UI for configuring and running any IDAES flowsheet - id: recaEF9qZRh2ehE59 - name: Flowsheet Processor UI - projects: - - recKkXobkOB85kvR3 - - recCwLQQYPhrvmypf - - reciZ8S487CQTeWr0 -- code: {} - description: Self-contained, one-click-installer graphical application for interacting - with PrOMMiS flowsheets - id: recjgxfwc9terwxSj - interface: Graphical (GUI) - name: PrOMMiS Flowsheet UI - projects: - - reciZ8S487CQTeWr0 - - recsrajWweFWzVZkj -- code: - github: watertap-org/reflo - description: An extension of WaterTAP that incorporates renewable energy (RE) models - for RE-driven desalination systems - id: recnqJXUTERJVjwld - interface: Python API - name: WaterTAP-REFLO - projects: - - recCwLQQYPhrvmypf + projects: WaterTAP,PrOMMiS - code: + conda-forge: '' github: prommis/prommis pypi: prommis description: PrOMMiS model library - id: recohrsW4jQecmeet interface: Python API + links: '' name: PrOMMiS - projects: - - reciZ8S487CQTeWr0 - ui_products: Flowsheet Processor -- code: - github: watertap-org/watertap - pypi: watertap - description: WaterTAP core model library - id: recrNZ8wwJ1g7yMQU - interface: Python API - name: WaterTAP - projects: - - recCwLQQYPhrvmypf + projects: PrOMMiS - code: - conda-forge: idaes-pse - github: IDAES/idaes-pse - pypi: idaes-pse - description: IDAES core Python framework and model library - id: recrQvKbvIiGNKdnp + conda-forge: '' + github: watertap-org/reflo + pypi: '' + description: An extension of WaterTAP that incorporates renewable energy (RE) models + for RE-driven desalination systems interface: Python API - name: IDAES-PSE - projects: - - recKkXobkOB85kvR3 + links: '' + name: WaterTAP-REFLO + projects: WaterTAP - code: + conda-forge: '' github: prommis/idaes-flowsheet-processor pypi: idaes-flowsheet-processor description: API for exporting flowsheets to the Flowsheet Processor UI - id: rectTp0jw8PApuxYt interface: Python API + links: '' name: Flowsheet Processor - projects: - - recKkXobkOB85kvR3 - - reciZ8S487CQTeWr0 - - recCwLQQYPhrvmypf + projects: IDAES,PrOMMiS,WaterTAP - code: - github: CCSI-Toolset/FOQUS - pypi: ccsi-foqus - description: Framework for Optimization and Uncertainty Quantification - id: recvoDYtA4ujC1Wlb + conda-forge: '' + github: prommis/idaes-flowsheet-processor-ui + pypi: '' + description: Graphical UI for configuring and running any IDAES flowsheet + interface: '' + links: '' + name: Flowsheet Processor UI + projects: IDAES,WaterTAP,PrOMMiS +- code: + conda-forge: '' + github: '' + pypi: '' + description: Self-contained, one-click-installer graphical application for interacting + with IDAES flowsheets interface: Graphical (GUI) - name: FOQUS - projects: - - recvKtsfJWeabhMYe + links: '' + name: IDAES Flowsheet UI + projects: IDAES,PARETO - code: - conda-forge: pyomo - github: Pyomo/pyomo - pypi: pyomo - description: Pyomo is an open-source Python package for modeling and solving equation-oriented - optimization problems, enabling users to define variables, constraints, and objectives - and solve them using various solvers, including LP, NLP, and MILP. - id: recxJK4smIb60kQ0x - interface: Python API - name: Pyomo -- code: {} + conda-forge: '' + github: '' + pypi: '' description: Self-contained, one-click-installer graphical application for interacting with WaterTAP flowsheets - id: recxwPyKuhcmbdp0f interface: Graphical (GUI) + links: '' name: WaterTAP Flowsheet UI - projects: - - recCwLQQYPhrvmypf - - recsrajWweFWzVZkj + projects: WaterTAP,PARETO +- code: + conda-forge: '' + github: '' + pypi: '' + description: Self-contained, one-click-installer graphical application for interacting + with PrOMMiS flowsheets + interface: Graphical (GUI) + links: '' + name: PrOMMiS Flowsheet UI + projects: PrOMMiS,PARETO projects: - active: true - description: Water treatment Techno-economic Analysis Platform + description: Carbon Capture Simulation for Industry Impact development: Active - homepage: https://watertap.readthedocs.io - id: recCwLQQYPhrvmypf - keywords: - - water treatment - - water chemistry - - techno-economic analysis - name: WaterTAP - products: - - recrNZ8wwJ1g7yMQU - - recSKlnunMYP1HZIh - - recnqJXUTERJVjwld - - rectTp0jw8PApuxYt - - recaEF9qZRh2ehE59 - - recxwPyKuhcmbdp0f + homepage: https://netl.doe.gov/carbon-management/carbon-capture/ccsi2 + keywords: carbon capture,simulation,modeling,optimization,uncertainty quantification + name: CCSI2 + notes: '' + products: FOQUS - active: true description: Institute for the Design of Advanced Energy Systems development: Active homepage: https://idaes.org - id: recKkXobkOB85kvR3 - keywords: - - equation oriented + keywords: equation oriented name: IDAES - products: - - recrQvKbvIiGNKdnp - - rectTp0jw8PApuxYt - - recaEF9qZRh2ehE59 - - recThdJTFwvbxTVci + notes: '' + products: IDAES-PSE,Flowsheet Processor,Flowsheet Processor UI,IDAES Flowsheet UI - active: true - description: 'Python-based, open-source optimization modeling language ' + description: Produced Water Initiative development: Active - homepage: https://www.pyomo.org/ - id: recPCScuWwcVicSx4 - keywords: - - equation oriented - - optimization - name: Pyomo -- active: false - description: Design Integration and Synthesis Platform to Advance Tightly Coupled - Hybrid Energy Systems - development: Archived - homepage: https://dispatches.readthedocs.io - id: recQEM5uwn2AtTRip - keywords: - - grid - - hybrid energy systems - name: DISPATCHES + homepage: https://project-pareto.org + keywords: produced water,optimization + name: PARETO + notes: '' + products: PrOMMiS Flowsheet UI,WaterTAP Flowsheet UI,IDAES Flowsheet UI - active: true description: Process Optimization and Modeling for Minerals Sustainability development: Active homepage: https://netl.doe.gov/prommis - id: reciZ8S487CQTeWr0 - keywords: - - critical minerals - - rare earth elements - models: Evaporation pond, Leaching, Feed roaster, Oxalate roaster, Solvent extraction, - Precipitate, Crusher, Nanofiltration, Diafiltration, REE processing plant + keywords: critical minerals,rare earth elements name: PrOMMiS - products: - - recSKlnunMYP1HZIh - - rectTp0jw8PApuxYt - - recohrsW4jQecmeet - - recaEF9qZRh2ehE59 - - recjgxfwc9terwxSj + notes: '' + products: Parameter Sweep,Flowsheet Processor,PrOMMiS,Flowsheet Processor UI,PrOMMiS + Flowsheet UI - active: true - description: Produced Water Initiative + description: 'Python-based, open-source optimization modeling language ' development: Active - homepage: https://project-pareto.org - id: recsrajWweFWzVZkj - keywords: - - produced water - - optimization - name: PARETO - products: - - recjgxfwc9terwxSj - - recxwPyKuhcmbdp0f - - recThdJTFwvbxTVci + homepage: https://www.pyomo.org/ + keywords: equation oriented,optimization + name: Pyomo + notes: '' + products: '' - active: true - description: Carbon Capture Simulation for Industry Impact + description: Water treatment Techno-economic Analysis Platform development: Active - homepage: https://netl.doe.gov/carbon-management/carbon-capture/ccsi2 - id: recvKtsfJWeabhMYe - keywords: - - carbon capture - - simulation - - modeling - - optimization - - uncertainty quantification - name: CCSI2 - products: - - recvoDYtA4ujC1Wlb + homepage: https://watertap.readthedocs.io + keywords: water treatment,water chemistry,techno-economic analysis + name: WaterTAP + notes: '' + products: WaterTAP,Parameter Sweep,WaterTAP-REFLO,Flowsheet Processor,Flowsheet + Processor UI,WaterTAP Flowsheet UI +- active: false + description: Design Integration and Synthesis Platform to Advance Tightly Coupled + Hybrid Energy Systems + development: Archived + homepage: https://dispatches.readthedocs.io + keywords: grid,hybrid energy systems + name: DISPATCHES + notes: '' + products: '' ui_products: -- description: "Run and modify optimization analyses of produced water networks created\ - \ under the Produced Water Optimization Initiative (PARETO). PARETO provides advanced\ - \ _decision support_ \_solutions for the disposition of produced water from onshore\ - \ oil & gas operations which are intuitive and accessible to field and system\ - \ engineers." - features: - - Adaptable to a wide variety of technologies and geographies - - Future integrations with subsurface modeling, orphan wells plugging, optimization, - and other related solutions - - Cross-platform graphical UI for Windows, MacOS, and Linux, with one-click install - - Table-based inputs, editable in Excel or in the tool, specifying water source/sink/etc. - details - - Optimization step with "override" to take advantage of field operator knowledge - id: recPTtwbDsHtFP58m - links: - docs: '' - gh: https://www.project-pareto.org - screenshots: PARETO UI - modelcompatibility: - - Custom - name: PARETO UI - repository: https://www.project-pareto.org - screenshots: - - description: - - Input screen for PARETO optimization - image: pareto-input.png - title: Input screen - - description: - - Output screen showing the results of a PARETO optimization - image: pareto-output.png - title: Output screen -- description: Create specific classes of superstructures, for decision support, with - a drag-and-drop UI. - features: - - Create superstructures composed of feedstock, processing stages, and target products - with a drag-and-drop UI - - Add units to processing stages, configuring performance and cost of each - - Connect processing units between adjacent stages - - Run optimization and determine optimal connections for cost objective - id: recRnL9FjR4hsa1as - links: - docs: '' - gh: https://github.com/prommis/prommis-ui - screenshots: Superstructure UI - modelcompatibility: - - Custom - name: Superstructure UI - repository: https://github.com/prommis/prommis-ui - screenshots: - - description: - - Superstructure (for HDD extraction) with input dialog shown for one unit - image: superstructure-1.png - title: Build superstructure - - description: - - Superstructure (for HDD extraction) results, with optimal processing selected - and costs (OPEX, CAPEX, net present value) shown - image: superstructure-2.png - title: Solve superstructure -- description: Enabling advanced Process Systems Engineering (PSE) capabilities to - be integrated with commercial process simulation software. - documentation: https://foqus.readthedocs.io/ - features: - - Cross-platform desktop UI (PyQT) - - Integration of models from process simulators (SimSinter) - - Derivative-free optimization (DFO) with Turbine - - Algebraic surrogate models to support large-scale deterministic optimization - - Uncertainty Quantification (UQ) - - Optimization Under Uncertainty (OUU) for scenario-based optimization - - Sequential Design of Experiments (SDoE) - id: recUIMiwO6x7JMpYs - links: - docs: https://foqus.readthedocs.io/ - gh: https://github.com/CCSI-Toolset/FOQUS - screenshots: '' - modelcompatibility: - - Custom - - Pyomo - name: FOQUS - repository: https://github.com/CCSI-Toolset/FOQUS - screenshots: {} - description: Run IDAES flowsheets with no coding and view graphical results. documentation: https://prommis.github.io/idaes-flowsheet-processor-ui/ features: @@ -3006,13 +6172,11 @@ ui_products: - Runs the model once or in a parameter sweep - Compare run results - Tabular and graphical results. Export to CSV (for Excel, etc.) - id: recgkyR4MS4J5ow5b links: docs: https://prommis.github.io/idaes-flowsheet-processor-ui/ gh: https://github.com/prommis/idaes-flowsheet-processor-ui screenshots: Flowsheet Processor - modelcompatibility: - - IDAES + modelcompatibility: IDAES name: Flowsheet Processor repository: https://github.com/prommis/idaes-flowsheet-processor-ui screenshots: @@ -3038,13 +6202,11 @@ ui_products: - Flowsheet diagram can be rearranged and saved - Stream table is shown automatically, and linked to streams in the diagram - Diagnostics toolkit is accessible through the UI - id: recpsQLvvzokxNXCM links: docs: https://idaes-ui.readthedocs.io/en/latest/user/fv/ gh: https://github.com/IDAES/idaes-ui screenshots: Flowsheet Visualizer - modelcompatibility: - - IDAES + modelcompatibility: IDAES name: Flowsheet Visualizer repository: https://github.com/IDAES/idaes-ui screenshots: @@ -3071,14 +6233,11 @@ ui_products: - View connectivity in text-based diagrams Mermaid or D2 - Add unit names, stream names, and user-defined annotations - Export connectivity as a table (CSV) for re-use in other tools - id: recrhJBL0I95RtMKW links: docs: https://prommis.github.io/idaes-connectivity/ gh: https://github.com/prommis/idaes-connectivity screenshots: Flowsheet Connectivity - modelcompatibility: - - Pyomo - - IDAES + modelcompatibility: Pyomo,IDAES name: Flowsheet Connectivity repository: https://github.com/prommis/idaes-connectivity screenshots: @@ -3089,3 +6248,78 @@ ui_products: - Output will be translated to a Mermaid diagram image: example_mermaid.png title: Run the tool +- description: Create specific classes of superstructures, for decision support, with + a drag-and-drop UI. + documentation: '' + features: + - Create superstructures composed of feedstock, processing stages, and target products + with a drag-and-drop UI + - Add units to processing stages, configuring performance and cost of each + - Connect processing units between adjacent stages + - Run optimization and determine optimal connections for cost objective + links: + docs: '' + gh: https://github.com/prommis/prommis-ui + screenshots: Superstructure UI + modelcompatibility: Custom + name: Superstructure UI + repository: https://github.com/prommis/prommis-ui + screenshots: + - description: + - Superstructure (for HDD extraction) with input dialog shown for one unit + image: superstructure-1.png + title: Build superstructure + - description: + - Superstructure (for HDD extraction) results, with optimal processing selected + and costs (OPEX, CAPEX, net present value) shown + image: superstructure-2.png + title: Solve superstructure +- description: "Run and modify optimization analyses of produced water networks created\ + \ under the Produced Water Optimization Initiative (PARETO). PARETO provides advanced\ + \ _decision support_ \_solutions for the disposition of produced water from onshore\ + \ oil & gas operations which are intuitive and accessible to field and system\ + \ engineers." + documentation: '' + features: + - Adaptable to a wide variety of technologies and geographies + - Future integrations with subsurface modeling, orphan wells plugging, optimization, + and other related solutions + - Cross-platform graphical UI for Windows, MacOS, and Linux, with one-click install + - Table-based inputs, editable in Excel or in the tool, specifying water source/sink/etc. + details + - Optimization step with "override" to take advantage of field operator knowledge + links: + docs: '' + gh: https://www.project-pareto.org + screenshots: PARETO UI + modelcompatibility: Custom + name: PARETO UI + repository: https://www.project-pareto.org + screenshots: + - description: + - Input screen for PARETO optimization + image: pareto-input.png + title: Input screen + - description: + - Output screen showing the results of a PARETO optimization + image: pareto-output.png + title: Output screen +- description: Enabling advanced Process Systems Engineering (PSE) capabilities to + be integrated with commercial process simulation software. + documentation: https://foqus.readthedocs.io/ + features: + - Cross-platform desktop UI (PyQT) + - Integration of models from process simulators (SimSinter) + - Derivative-free optimization (DFO) with Turbine + - Algebraic surrogate models to support large-scale deterministic optimization + - Uncertainty Quantification (UQ) + - Optimization Under Uncertainty (OUU) for scenario-based optimization + - Sequential Design of Experiments (SDoE) + links: + docs: https://foqus.readthedocs.io/ + gh: https://github.com/CCSI-Toolset/FOQUS + screenshots: '' + modelcompatibility: Custom,Pyomo + name: FOQUS + repository: https://github.com/CCSI-Toolset/FOQUS + screenshots: {} diff --git a/data/models.csv b/data/models.csv new file mode 100644 index 0000000..f543c2e --- /dev/null +++ b/data/models.csv @@ -0,0 +1,1191 @@ +Name,Project,Description,Flowsheet module,Unit models,Unit model repositories,"Inherited model (name, unit model)",Inherited model repository,Control volumes,Control volume repositories,Property packages,Property package repositories,Reaction packages,Reaction package repositories,Configurations,Specifications for operating conditions,Mandatory config options +Activity coefficient model,IDAES,NRTL and Wilson activity coefficient methods,,,,,,,,,idaes/models/properties/activity_coeff_models/activity_coeff_prop_pack.py,,,,, +Activity coefficient model: benzene-toluene-xylene VLE,IDAES,"Example property package for the VLE calculations for a Benzene-Toluene-o-Xylene +system. If using the activity coefficient models (NRTL or Wilson), the user is +expected to provide the parameters necessary for these models. ",,,,,,,,,idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py,,,,, +Activity coefficient model: methane combustion,IDAES,"Property package for the VLE calculations for methane combustion. +system.",,,,,,,,,idaes/models/properties/activity_coeff_models/methane_combustion_ideal.py,,,,, +ADM1 to ASM1 Translator,WaterTAP,,,Translator_ADM1_ASM1,watertap/unit_models/translators/translator_adm1_asm1.py,Translator,idaes/models/unit_models/translator.py,,,"ADM1ParameterBlock +ASM1ParameterBlock +(Liq phase)","watertap/property_models/unit_specific/activated_sludge/adm1_properties.py +watertap/property_models/unit_specific/activated_sludge/asm1_properties.py",ADM1ReactionParameterBlock,watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py,"outlet_state_defined +has_phase_equilibrium +inlet_property_package +inlet_property_package_args +outlet_property_package +outlet_property_package_args +reaction_package +reaction_package_args","Inlet feed state variables (i.e., temperature, pressure, volumetric flowrate, solute compositions, cations, anions).", +ADM1 to ASM2d Translator,WaterTAP,,,Translator_ADM1_ASM2D,watertap/unit_models/translators/translator_adm1_asm2d.py,Translator,idaes/models/unit_models/translator.py,,,"ModifiedADM1ParameterBlock +ModifiedASM2dParameterBlock","watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py","ModifiedADM1ReactionParameterBlock +ModifiedASM2dReactionParameterBlock","watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py","outlet_state_defined +has_phase_equilibrium +inlet_property_package +inlet_property_package_args +outlet_property_package +outlet_property_package_args +inlet_reaction_package +inlet_reaction_package_args +outlet_reaction_package +outlet_reaction_package_args","Inlet feed state variables (i.e., temperature, pressure, volumetric flowrate, solute compositions).", +Aeration Basin (ZO),WaterTAP,,,AerationBasinZO,watertap/unit_models/zero_order/aeration_basin_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Aeration Tank,WaterTAP,,,AerationTank,watertap/unit_models/aeration_tank.py,"CSTR Injection, CSTR_Injection",watertap/unit_models/cstr_injection.py,,,"ASM1ParameterBlock +ASM2dParameterBlock +ModifiedASM2dParameterBlock +ADM1ParameterBlock +(Single Liq phase)","watertap/property_models/unit_specific/activated_sludge/asm1_properties.py; +watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py; +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py; +watertap/property_models/unit_specific/activated_sludge/adm1_properties.py","ASM1ReactionParameterBlock; +ASM2dReactionParameterBlock; +ModifiedASM2dReactionParameterBlock; +ADM1ReactionParameterBlock","watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py +watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py; +watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py","material_balance_type +energy_balance_type +momentum_balance_type +has_heat_transfer +has_pressure_change +has_equilibrium_reactions +has_phase_equilibrium +has_heat_of_reaction +electricity_consumption +has_aeration","Inlet feed state variables (i.e. temperature, pressure, component flowrates), volume or hydraulic retention time, injection rates for all components, lumped mass transfer coefficient for oxygen*, dissolved oxygen concentration at equilibrium*, if heat transfer is included: heat duty, if pressure change is included: change in pressure. +*These degrees of freedom should only be included if the oxygen injection rate is not specified and needs to be calculated.", +Air Flotation (ZO),WaterTAP,,,AirFlotationZO,watertap/unit_models/zero_order/air_flotation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +"Air separation equilibrium, Peng-Robinson",IDAES,Air separation phase equilibrium package using Peng-Robinson EoS.,,,,,,,,,idaes/models/properties/modular_properties/examples/ASU_PR.py,,,,, +Anaerobic Digester,WaterTAP,,,AD,watertap/unit_models/anaerobic_digester.py,,,,,"ADM1ParameterBlock (Liq phase); +ADM1_vaporParameterBlock (Vap phase)","watertap/property_models/unit_specific/anaerobic_digestion/adm1_properties.py; +watertap/property_models/unit_specific/anaerobic_digestion/adm1_properties_vapor.py",ADM1ReactionParameterBlock,watertap/property_models/unit_specific/anaerobic_digestion/adm1_reactions.py,"material_balance_type +energy_balance_type +momentum_balance_type +has_heat_transfer +has_pressure_change +has_equilibrium_reactions +has_phase_equilibrium +has_heat_of_reaction +liquid_property_package +liquid_property_package_args +vapor_property_package +vapor_property_package_args +reaction_package +reaction_package_args","Inlet feed state variables (temperature, pressure, component flowrates), cation concentration, anion concentration, liquid volume, vapor volume, liquid outlet temperature.","dynamic +has_holdup +property_package +property_package_args" +Anaerobic Digestion (ZO),WaterTAP,,,AnaerobicDigestionOxidationZO,watertap/unit_models/zero_order/anaerobic_digestion_oxidation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Anaerobic Digestion Reactive (ZO),WaterTAP,,,AnaerobicDigestionReactiveZO,watertap/unit_models/zero_order/anaerobic_digestion_reactive_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +ASM1 to ADM1 Translator,WaterTAP,,,Translator_ASM1_ADM1,watertap/unit_models/translators/translator_asm1_adm1.py,Translator,idaes/models/unit_models/translator.py,,,"ASM1ParameterBlock +ADM1ParameterBlock +(Liq phase)","watertap/property_models/unit_specific/activated_sludge/asm1_properties.py +watertap/property_models/unit_specific/activated_sludge/adm1_properties.py",ADM1ReactionParameterBlock,watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py,"outlet_state_defined +has_phase_equilibrium +inlet_property_package +inlet_property_package_args +outlet_property_package +outlet_property_package_args +reaction_package +reaction_package_args","Inlet feed state variables (i.e., temperature, pressure, volumetric flowrate, solute compositions, cations, anions).", +ASM2d to ADM1 Translator,WaterTAP,,,Translator_ASM2d_ADM1,watertap/unit_models/translators/translator_asm2d_adm1.py,Translator,idaes/models/unit_models/translator.py,,,"ModifiedADM1ParameterBlock +ModifiedASM2dParameterBlock","watertap/property_models/unit_specific/activated_sludge/modified_adm1_properties.py +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py","ModifiedADM1ReactionParameterBlock; +ModifiedASM2dReactionParameterBlock","watertap/property_models/unit_specific/activated_sludge/modified_adm1_reactions.py; +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py","outlet_state_defined +has_phase_equilibrium +inlet_property_package +inlet_property_package_args +outlet_property_package +outlet_property_package_args +bio_P +inlet_reaction_package +inlet_reaction_package_args +outlet_reaction_package +outlet_reaction_package_args","Inlet feed state variables (i.e., temperature, pressure, volumetric flowrate, solute compositions).", +Autothermal Hydrothermal Liquefaction (ZO),WaterTAP,,,ATHTLZO,watertap/unit_models/zero_order/autothermal_hydrothermal_liquefaction_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Backwash Solids Handling (ZO),WaterTAP,,,BackwashSolidsHandlingZO,watertap/unit_models/zero_order/backwash_solids_handling_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +"Benzene-toluene equilibrium, ideal",IDAES,Benzene-Toluene phase equilibrium package using ideal liquid and vapor.,,,,,,,,,idaes/models/properties/modular_properties/examples/BT_ideal.py,,,,, +"Benzene-toluene equilibrium, Peng-Robinson",IDAES,Benzene-toluene phase equilibrium package for liquid and vapor using the Peng-Robinson equation of state.,,,,,,,,,idaes/models/properties/modular_properties/examples/BT_PR.py,,,,, +Bio Active Filtration (ZO),WaterTAP,,,BioActiveFiltrationZO,watertap/unit_models/zero_order/bio_active_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Bioreactor (ZO),WaterTAP,,,BioreactorZO,watertap/unit_models/zero_order/bioreactor_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Blending Reservoir (ZO),WaterTAP,,,BlendingReservoirZO,watertap/unit_models/zero_order/blending_reservoir_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Boron Removal,WaterTAP,,,BoronRemoval,watertap/unit_models/boron_removal.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +is_isothermal +chemical_mapping_data","Inlet feed state variables (i.e., temperature, pressure, component molar flowrates), caustic chemical dose rate, reactor volume.", +Brine Concentrator (ZO),WaterTAP,,,BrineConcentratorZO,watertap/unit_models/zero_order/brine_concentrator_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Bubble and dew points,IDAES,Modular methods for calculating bubble and dew points.,,,,,,,,,idaes/models/properties/modular_properties/phase_equil/bubble_dew.py,,,,, +Buffer Tank (ZO),WaterTAP,,,BufferTankZO,watertap/unit_models/zero_order/buffer_tank_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +CANDO-P (ZO),WaterTAP,,,CANDOP,watertap/unit_models/zero_order/CANDOP_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Cartridge Filtration (ZO),WaterTAP,,,CartridgeFiltrationZO,watertap/unit_models/zero_order/cartridge_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Centrifuge (ZO),WaterTAP,,,CentrifugeZO,watertap/unit_models/zero_order/centrifuge_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Chemical Addition (ZO),WaterTAP,,,ChemicalAdditionZO,watertap/unit_models/zero_order/chemical_addition_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Chlorination (ZO),WaterTAP,,,ChlorinationZO,watertap/unit_models/zero_order/chlorination_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Clarifier,WaterTAP,,,Clarifier,watertap/unit_models/clarifier.py,"Separator, Separator",idaes/models/unit_models/separator.py,,,ASM1ParameterBlock (Liq phase),watertap/property_models/unit_specific/activated_sludge/asm1_properties.py,,,"outlet_list +num_outlets (not used if outlet_list arg is provided) +split_basis +material_balance_type +momentum_balance_type +has_phase_equilibrium +energy_split_basis +ideal_separation +ideal_split_map +mixed_state_block +construct_ports","Inlet feed state variables (temperature, pressure, component flowrates), alkalinity, split fraction, surface area. +Degrees of freedom based on the separation type chosen: +split_basis = ‘componentFlow’, DOF = (#outlets - 1) * #components +split_basis = ‘phaseFlow’, DOF = (#outlets - 1) * #phases +split_basis = ‘phaseComponentFlow’ or split_basis = ‘totalFlow’, DOF = (#outlets - 1) * #components * #phases", +Clarifier (ZO),WaterTAP,,,ClarifierZO,watertap/unit_models/zero_order/clarifier_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Cloth Media Filtration (ZO),WaterTAP,,,ClothMediaFiltration,watertap/unit_models/zero_order/cloth_media_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +CO2 Addition (ZO),WaterTAP,,,CO2AdditionZO,watertap/unit_models/zero_order/co2_addition_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +"CO2-bmimPF6 phase equilibrium, Peng-Robinson",IDAES,CO2-bmimPF6 phase equilibrium package using ideal liquid and vapor.,,,,,,,,,idaes/models/properties/modular_properties/examples/CO2_bmimPF6_PR.py,,,,, +"CO2-H2O VLE, ideal",IDAES,"Property package for MEA Carbon Capture System Condenser. CO2-H2O VLE system, ideal VLE with non-condensables.",,,,,,,,,idaes/models/properties/modular_properties/examples/CO2_H2O_Ideal_VLE.py,,,,, +Coagulation Flocculation (ZO),WaterTAP,,,CoagulationFlocculationZO,watertap/unit_models/zero_order/coag_and_floc_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Coagulation-Flocculation,WaterTAP,,,CoagulationFlocculation,watertap/unit_models/coag_floc_model.py,,,,,"NaClParameterBlock +SeawaterParameterBlock +(Liq phase)","watertap/property_models/NaCl_prop_pack.py +watertap/property_models/seawater_prop_pack.py",,,"material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type +chemical_additives","Inlet feed state variables (i.e., temperature, pressure, component mass flowrates), slope relationship between measured Turbidity and TSS, intercept relationship between measured Turbidity and TSS, turbidity measured before Jar Test, turbidity measured after Jar Test, chemical doses added during Jar Test, retention time for each rapid mixer, number of rapid mixers in series, rapid mixer velocity gradient, retention time of flocculation basin, flocculation single paddle length (from center of rotation to blade edge), flocculation single paddle width, flocculation paddle rotational speed, flocculation paddle drag coefficient, flocculation paddle velocity fraction, number of rotating paddle wheels, number of paddles per wheel", +Cofermentation (ZO),WaterTAP,,,CofermentationZO,watertap/unit_models/zero_order/cofermentation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Complementarity-based vapor-liquid equilibrium formulation,IDAES,"A complementarity-based vapor-liquid equilibrium formulation for equation-oriented simulation +and optimization.",,,,,,,,,idaes/models/properties/modular_properties/phase_equil/smooth_VLE_2.py,,,,, +Compressor,IDAES,Isentropic compressor model.,,Compressor,idaes/models/unit_models/pressure_changer.py,,,,,,,,,,, +Constructed Wetlands (ZO),WaterTAP,,,ConstructedWetlandsZO,watertap/unit_models/zero_order/constructed_wetlands_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Continuous stirred-tank reactor,IDAES,Standard IDAES continuous stirred-tank model.,,CSTR,idaes/models/unit_models/cstr.py,,,,,SaponificationParameterBlock,idaes/models/properties/examples/saponification_thermo.py,SaponificationReactionParameterBlock,idaes/models/properties/examples/saponification_reactions.py,"material_balance_type +energy_balance_type +momentum_balance_type +has_heat_transfer +has_pressure_change +has_equilibrium_reactions +has_phase_equilibrium +has_heat_of_reaction +property_package +property_package_args +reaction_package +reaction_package_args","Inlet feed state variables (molar flowrate, component concentrations, temperature, pressure), heat duty, perssure drop", +Continuously Stirred Tank Reactor,WaterTAP,,,CSTR,watertap/unit_models/cstr.py,"CSTR, CSTR",idaes/models/unit_models/cstr.py,,,"SaponificationParameterBlock +ASM1ParameterBlock (Liq phase)"," +idaes/models/properties/examples/saponification_thermo.py +watertap/property_models/unit_specific/activated_sludge/asm1_properties.py","SaponificationReactionParameterBlock; +ASM1ReactionParameterBlock","idaes/models/properties/examples/saponification_reactions.py; +watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py","material_balance_type +energy_balance_type +momentum_balance_type +has_heat_transfer +has_pressure_change +has_equilibrium_reactions +has_phase_equilibrium +has_heat_of_reaction +reaction_package +reaction_package_args","Inlet feed state variables (i.e. temperature, pressure, component flowrates), volume or hydraulic retention time.", +Continuously Stirred Tank Reactor with Injection,WaterTAP,,,CSTR_Injection,watertap/unit_models/cstr_injection.py,,,,,"SaponificationParameterBlock +ASM1ParameterBlock +ASM2dParameterBlock +ModifiedASM2dParameterBlock +ADM1ParameterBlock","idaes/models/properties/examples/saponification_thermo.py +watertap/property_models/unit_specific/activated_sludge/asm1_properties.py +watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py +watertap/property_models/unit_specific/activated_sludge/adm1_properties.py","SaponificationReactionParameterBlock; +ASM1ReactionParameterBlock; +ASM2dReactionParameterBlock; +ModifiedASM2dReactionParameterBlock; +ADM1ReactionParameterBlock","idaes/models/properties/examples/saponification_reactions.py; +watertap/property_models/unit_specific/activated_sludge/asm1_reactions.py; +watertap/property_models/unit_specific/activated_sludge/asm2d_reactions.py; +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_reactions.py; +watertap/property_models/unit_specific/activated_sludge/adm1_reactions.py","material_balance_type +energy_balance_type +momentum_balance_type +has_heat_transfer +has_pressure_change +has_equilibrium_reactions +has_phase_equilibrium +has_heat_of_reaction +reaction_package +reaction_package_args +electricity_consumption +has_aeration","Inlet feed state variables (i.e. temperature, pressure, component flowrates), volume or hydraulic retention time, injection rates for all components, heat duty if heat transfer is included, change in pressure if pressure change is included. If aeration is included, the following degrees of freedom could replace the oxygen injection rate: lumped mass transfer coefficient for oxygen, dissolved oxygen concentration at equilibrium.", +Controller,IDAES,PID controller model.,,,"idaes/models/control +/controller.py",,,,,,,,,,, +Conventional Activated Sludge (ZO),WaterTAP,,,CASZO,watertap/unit_models/zero_order/conventional_activated_sludge_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Cooling Supply (ZO),WaterTAP,,,CoolingSupplyZO,watertap/unit_models/zero_order/cooling_supply_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Cooling Tower (ZO),WaterTAP,,,CoolingTowerZO,watertap/unit_models/zero_order/cooling_tower_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Coolprop,IDAES,"Module for constructing CoolProp expressions and methods for looking up and using CoolProp parameters +within the IDAES generic properties framework.",,,,,,,,,idaes/models/properties/modular_properties/coolprop,,,,, +Costing,IDAES,Costing package that includes methods for capital costing of unit operations. ,,,idaes/models/costing/SSLW.py,,,,,,,,,,, +Crusher,PrOMMiS,"The Crusher module includes power consumption for solid crushing. It is a function of particle size distribution, mass flow rate, and bond work index.",,Crusher,prommis/solid_handling/crusher,,,,,CoalRefuseParameters,prommis/solid_handling/crusher_solids_properties.py,,,,"Inlet mass flowrate and fractions, inlet particle size median and width, outlet particle size median and width", +Crystallizer (0D),WaterTAP,,,Crystallization,watertap/unit_models/crystallizer.py,,,,,"NaClParameterBlock +(solid-liquid-vapour mixtures)",watertap/property_models/NaCl_prop_pack.py,,,,"Inlet feed state variables (i.e. temperature, pressure, component flowrates), crystal growth rate, desired median length of solid crystals, parameter for Sounders-Brown relation, crystallization temperature. To fully specify the unit: crystallization yield, solids volumetric fraction of product slurry, magma density, solid outlet mass flow, vapour outlet mass flow", +Cubic Equations of State,IDAES,Generic module for PR and SRK cubic equations of state,,,,,,,,,idaes/models/properties/modular_properties/eos,,,,, +Decarbonator (ZO),WaterTAP,,,DecarbonatorZO,watertap/unit_models/zero_order/decarbonator_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Deep Well Injection (ZO),WaterTAP,,,DeepWellInjectionZO,watertap/unit_models/zero_order/deep_well_injection_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Demonstration flowsheet,IDAES,"Simple example of a flowsheet containing a Mixer, Heater and Flash unit in series.",idaes/models/flowsheets/demo_flowsheet.py,"Mixer +Heater +Flash",idaes/models/unit_models,,,,,BTX_activity_coeff_VLE,idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py,,,,, +Dewatering Unit,WaterTAP,,,DewateringUnit,watertap/unit_models/dewatering.py,"Separator, Separator",idaes/models/unit_models/separator.py,,,"ASM1ParameterBlock +ASM2dParameterBlock +ModifiedASM2dParameterBlock +ADM1ParameterBlock +(Single Liq phase)","watertap/property_models/unit_specific/activated_sludge/asm1_properties.py +watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py +watertap/property_models/unit_specific/activated_sludge/adm1_properties.py",,,"activated_sludge_model +outlet_list +num_outlets (not used if outlet_list arg is provided) +split_basis +material_balance_type +momentum_balance_type +has_phase_equilibrium +energy_split_basis +ideal_separation +ideal_split_map +mixed_state_block +construct_ports","Inlet feed state variables (i.e. temperature, pressure, component mass compositions).", +Diafiltration,PrOMMiS,"Diafiltration cascade flowsheet case study example for separating lithium and cobalt. This flowsheet models a specific system from literature (cascade III in Figure 2 [1]) and serves as an example of implementing a custom cost model. + +[1] https://pubs.acs.org/doi/full/10.1021/acssuschemeng.2c02862",prommis/nanofiltraion/diafiltration.py,MSContactor (3 units); Mixer (2 units),idaes/models/unit_models,,,,,LiCoParameters,prommis/nanofiltration/diafiltration_properties,,,,Diafiltrate feed (Mixer 2) flowrate and concentrations; Stage 3 feed florate and concentrations, Stage 3 feed florate and concentrations +Dissolved Air Flotation (ZO),WaterTAP,,,DissolvedAirFlotationZO,watertap/unit_models/zero_order/dissolved_air_flotation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Dual Media Filtration (ZO),WaterTAP,,,DualMediaFiltrationZO,watertap/unit_models/zero_order/dual_media_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Electrochemical Nutrient Removal (ZO),WaterTAP,,,ElectrocoagulationZO,watertap/unit_models/zero_order/electrocoagulation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Electrocoagulation (ZO),WaterTAP,,,ElectrodialysisReversalZO,watertap/unit_models/zero_order/electrodialysis_reversal_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric +electrode_material +reactor_material +overpotential_calculation",, +Electrodialysis (0D),WaterTAP,,,Electrodialysis0D,watertap/unit_models/electrodialysis_0D.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"has_pressure_change +pressure_drop_method +friction_factor_method +hydraulic_diameter_method +operation_mode +limiting_current_density_method +limiting_current_density_data +has_nonohmic_potential_membrane +has_Nernst_diffusion_layer +material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type","Inlet feed state variables (i.e. temperature, pressure, component molar flowrates). Water transport number, water permeability, voltage or current, electrode areal resistance, cell pair number, current utilization coefficient, spacer thickness, membrane areal resistance, cell width, cell length, thickness of ion exchange membranes, diffusivity of solute in the membrane phase, transport number of ions in the membrane phase.", +Electrodialysis (1D),WaterTAP,,,Electrodialysis1D,watertap/unit_models/electrodialysis_1D.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"has_pressure_change +pressure_drop_method +friction_factor_method +hydraulic_diameter_method +operation_mode +limiting_current_density_method +limiting_current_density_datahas_nonohmic_potential_membrane +has_Nernst_diffusion_layer +material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type +transformation_method +transformation_scheme +finite_elements +collocation_points","Inlet feed state variables (i.e. temperature, pressure, component molar flowrates). Water transport number, water permeability, voltage or current, electrode areal resistance, cell pair number, current utilization coefficient, channel height (spacer thickness), membrane areal resistance at infinitive ion concentration, membrane areal resistance coefficient to the reciprocal of the ion concentration, spacer conductivity coefficient, cell width, cell length, thickness of ion exchange membranes, diffusivity of solute in the membrane phase, transport number of ions in the membrane phase.", +Electrodialysis Reversal (ZO),WaterTAP,,,ElectroNPZO,watertap/unit_models/zero_order/electrochemical_nutrient_removal_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Electrodialysis w/ bipolar membranes (1D),WaterTAP,,,Electrodialysis_Bipolar_1D,watertap/unit_models/electrodialysis_bipolar_1D.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"has_pressure_change +pressure_drop_method +friction_factor_method +hydraulic_diameter_method +operation_mode +limiting_current_density_method_bpm +salt_calculation +limiting_current_density_data_bpm +salt_input_cem +salt_input_aem +limiting_potential_data +material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type +transformation_method +transformation_scheme +finite_elements +terms_fE +collocation_points","Inlet feed state variables (i.e. temperature, pressure, component molar flowrates). Water transport number, water permeability, dissociation rate constant at no electric field, relative permittivity, catalyst - CEL of the bipolar membrane, catalyst - AEL of the bipolar membrane, equilibrium constant of proton disassociation, equilibrium constant of hydroxide disassociation, ion transference number in the membrane phase, diffusivity of solute in the membrane phase, fixed salt concentration on the base and acid channel of the bipolar membrane (if no salt calculation), spacer porosity, shadow factor, electrode areal resistance, current utilization coefficient, channel height, cell width and length, constant areal resistance of membrane at infinity-approximated electrolyte concentration, membrane areal resistance coefficient to the reciprocal of the ion concentration, thickness of ion exchange membranes, cell triplet number, spacer conductivity coefficient, potential drop across the bipolar membrane, specific area of the channel (if hydraulic diameter method is set for spacer-filled channel requiring the spacer specific area data), membrane fixed charge, voltage or current applied (for constant voltage or constant current electrical operation mode).", +Electrolyzer,WaterTAP,,,Electrolyzer,watertap/unit_models/electrolyzer.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type","Inlet state variables (i.e., temperature, pressure, component flowrates), membrane current density, anode current density, anode overpotential, cathode current density, cathode overpotential, current, current efficiency, resistance. The electrolysis reactions at the anode and cathode must be specified for their stoichiometry and electrochemical potential.", +ElectroNP (ZO),WaterTAP,,,ElectroNPZO,watertap/unit_models/electroNP_ZO.py,"Separator, Separator",idaes/models/unit_models/separator.py,,,ModifiedASM2dParameterBlock (Liq phase),watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py,,,"outlet_list +num_outlets (not used if outlet_list arg is provided) +split_basis +material_balance_type +momentum_balance_type +has_phase_equilibrium +energy_split_basis +ideal_separation +ideal_split_map +mixed_state_block +construct_ports","Inlet state variables (i.e., temperature, pressure, volumetric flowrate), electricity intensity, dosage of magnesium chloride per phosphorus removal, inlet solute concentration.", +Energy Recovery (ZO),WaterTAP,,,EnergyRecoveryZO,watertap/unit_models/zero_order/energy_recovery_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Energy Recovery Device,WaterTAP,,,EnergyRecoveryDevice,watertap/unit_models/pressure_changer.py,"Pump, Pump (class PumpIsothermalData)",watertap/unit_models/pressure_changer.py,,,"SeawaterParameterBlock +MCASParameterBlock +(Liq phase)","watertap/property_models/seawater_prop_pack.py +watertap/property_models/multicomp_aq_sol_prop_pack.py",,,"material_balance_type +energy_balance_type +momentum_balance_type +has_phase_equilibrium +compressor +thermodynamic_assumption +support_isentropic_performance_curves +isentropic_performance_curves +isentropic_performance_curves (build_callback, build_head_expressions) +variable_efficiency","Outlet pressure or pressure change across the inlet and outlet, energy recovery device efficiency.", +eNRTL Activity Coefficient,IDAES,Generic model for Electrolyte Non-Random Two Liquid activity coefficient model,,,,,,,,,idaes/models/properties/modular_properties/eos,,,,, +"eNRTL, aqueous solutions of NaCl and KCl",IDAES,Example for using the eNRTL model for aqueous solutions of NaCl and KCl.,,,,,,,,,idaes/models/properties/modular_properties/examples/enrtl_H2O_NaCl_KCl.py,,,,, +"eNRTL, solutions of NaBr in mixed solvents",IDAES,Example of using the eNRTL model to model solutions of NaBr in mixed solvents.,,,,,,,,,idaes/models/properties/modular_properties/examples/enrtl_NaBr_mixed_solvent.py,,,,, +Equation of State: Span-Wagner,IDAES,Span-Wager property package for CO2.,,,,,,,,SWCO2ParameterBlock,idaes/models/properties/swco2.py,,,,, +Equilibrium reactions forms,IDAES,Methods for defining equilibrium reactions.,,,,,,,,,,,idaes/models/properties/modular_properties/reactions/equilibrium_forms.py,,, +Equilibrium reactor,IDAES,Standard IDAES equilibrium reactor model.,,EquilibriumReactor,idaes/models/unit_models/equilibrium_reactor.py,,,,,SaponificationParameterBlock,idaes/models/properties/examples/saponification_thermo.py,SaponificationReactionParameterBlock,idaes/models/properties/examples/saponification_reactions.py,"dynamic +has_holdup +material_balance_type +energy_balance_type +momentum_balance_type +has_rate_reactions +has_equilibrium_reactions +has_phase_equilibrium +has_heat_transfer +has_heat_of_reaction +has_pressure_change +property_package +property_package_args +reaction_package +reaction_package_args","Inlet feed state variables (molar flowrate, component concentrations, temperature, pressure), unit volume, heat duty, perssure drop", +Evaporation pond,PrOMMiS,"The Evaporation Pond model is a general purpose model for representing evaporation ponds (both solar and enhanced). Currently, the model only supports steady-state operation +(although it could be easily extended to dynamics). The model also only supports material balances with equilibrium reactions, as energy and momentum balances are less meaningful given the open-air nature of these operations and the long-duration time +constants involved.",,EvaporationPond, prommis/evaporation_pond/evaporation_pond,,,,,BrineParameters,prommis/evaporation_pond/tests/example_properties,BrineReactionParameters,prommis/evaporation_pond/tests.example_reactions,,"Inlet flowrate and concentrations, surface area, average pond depth, and evaporation rate", +Evaporation Pond (ZO),WaterTAP,,,EvaporationPondZO,watertap/unit_models/zero_order/evaporation_pond_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Feed,IDAES,Standard IDAES Feed block.,,Feed,idaes/models/unit_models/feed.py,,,,,,,,,"dynamic +has_holdup +property_package property_package_args",, +Feed (ZO),WaterTAP,,,FeedZO,watertap/unit_models/zero_order/feed_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,,, +Feed Flash,IDAES,Standard IDAES feed block with phase equilibrium.,,FeedFlash,idaes/models/unit_models/feed_flash.py,,,,,,,,,"dynamic +has_holdup +material_balance_type +flash_type +property_package +property_package_args",, +Feed roaster,PrOMMiS,"This model represents a roaster/calcination unit for Rare Earth Element (REE) feedstock, which includes rare earth minerals, gangue/impurity minerals, moisture, and combustible organic materials.",,REEFeedRoaster,prommis/roasting/ree_feed_roaster,,,,,GenericParameterBlock (gas); CoalRefuseParameters (solid).,idaes/models.properties/modular_properties/base/generic_property prommis/leaching/leach_solution_properties ,,,has_holdup; has_heat_transfer; has_pressure_change; ree_list,"Pressure drop, gas inlet temperature, pressure, mole flowrate, and mole fractions, gas outlet temperature, solid inlet temperature, mass flowrate, mass fractions, REE concentrations, conversion ratios of insolubale REE to dissovable REE, recovery fraction for REE and impurity", has_pressure_change +Feed Water Tank (ZO),WaterTAP,,,FeedWaterTankZO,watertap/unit_models/zero_order/feed_water_tank_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Filter Press (ZO),WaterTAP,,,FilterPressZO,watertap/unit_models/zero_order/filter_press_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Fixed Bed (ZO),WaterTAP,,,FixedBedZO,watertap/unit_models/zero_order/fixed_bed_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Flash,IDAES,Flash unit model.,,Flash,idaes/models/unit_models/flash.py,,,,,"BTX_activity_coeff_VLE +iapws95 +GenericParameterBlock, BT_ideal","idaes/models/properties/activity_coeff_models/BTX_activity_coeff_VLE.py +idaes/models/properties/iapws95.py +idaes/models/properties/modular_properties/base/generic_property.py +idaes/models/properties/modular_properties/examples/BT_ideal.py",,,,, +Gas Sparged Membrane (ZO),WaterTAP,,,GasSpargedMembraneZO,watertap/unit_models/zero_order/gas_sparged_membrane_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Gas viscosity at low pressures,IDAES,Gas viscosity at low pressures from Chapman Enskog theory using Lennard Jones parameters.,,,,,,,,,idaes/models/properties/modular_properties/pure/ChapmanEnskog.py,,,,, +Generic Desalter Unit,WaterTAP,,,GenericDesalter,watertap/unit_models/generic_desalter.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +has_pressure_change +tracked_solids_list","Inlet state variables (i.e., temperature, pressure, component mass compositions), water recovery or solids concentration in brine* and water content of the brine*. +*User must provide tracked solids list.", +Generic Property Framework,IDAES,General framework for supporting modular thermophsyical property packages.,,,,,,,,,idaes/models/properties/modular_properties/base/generic_property.py,,,,, +Generic Reaction Framework,IDAES,General framework for supporting modular reaction packages.,,,,,,,,,,,idaes/models/properties/modular_properties/base/generic_reaction.py,,, +Generic Separator Unit,WaterTAP,,,GenericSeparation,watertap/unit_models/generic_separation.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +has_pressure_change","Inlet state variables (i.e., temperature, pressure, component mass compositions), percent of component to remove from feed stream, amount of chemical to add for operation (additive_dose).", +Gibbs reactor,IDAES,Standard IDAES Gibbs reactor model.,,GibbsReactor,idaes/models/unit_models/gibbs_reactor.py,,,,,"GenericParameterBlock, MethaneParameterBlock","idaes/models/properties/activity_coeff_models/methane_combustion_ideal.py +idaes/models/properties/modular_properties/base/generic_property.py +idaes/models_extra/power_generation/properties/natural_gas_PR.py",,,,, +Granular Activated Carbon (GAC),WaterTAP,,,GAC,watertap/unit_models/gac.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type +film_transfer_coefficient_type +surface_diffusion_coefficient_type +target_species +finite_elements_ss_approximation","Inlet state variables (i.e., temperature, pressure, component flowrates), Freundlich adsorption isotherm parameters, Stanton number equation parameters, throughput ratio equation parameters, particle apparent density, particle diameter, empty bed contact time, bed voidage or particle bulk density, superficial velocity or bed length, effluent to inlet concentration ratio at operational time or steady state approximation of average effluent to inlet concentration ratio in operational time by trapezoid rule or bed volumes treated, surface diffusion coefficient, liquid phase film transfer coefficient. +When setting the configuration options to calculate the surface diffusion coefficient and liquid phase film transfer coefficient: shape correction factor, particle porosity, tortuosity of the path that the adsorbate must take as compared to the radius, surface-to-pore diffusion flux ratio.", +Granular Activated Carbon (ZO),WaterTAP,,,GACZO,watertap/unit_models/zero_order/gac_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Heat exchanger 0D,IDAES,Simple 0D heat exchanger model.,,HeatExchanger,idaes/models/unit_models/gibbs_reactor.py,,,,,,,,,,, +Heat exchanger 1D,IDAES,Simple 1D heat exchanger model.,,HeatExchanger1D,idaes/models/unit_models/heat_exchanger_1D.py,,,,,,,,,,, +Heat exchanger lumped capacitance,IDAES,Extension of the IDAES 0D heat exchanger model for transient simulations.,,HeatExchangerLumpedCapacitance,idaes/models/unit_models/heat_exchanger_lc.py,,,,,,,,,,, +Heat exchanger NTU,IDAES,IDAES heat exchanger model using effectiveness-NTU method.,,HeatExchangerNTU,idaes/models/unit_models/heat_exchanger_ntu.py,,,,,,,,,,, +Heat of reaction,IDAES,Methods for calculating heat of reaction.,,,,,,,,,,,idaes/models/properties/modular_properties/reactions/dh_rxn.py,,, +Heater,IDAES,Simple 0D heater/cooler model.,,Heater,idaes/models/unit_models/heater.py,,,,,,,,,,, +Helmholtz Equation of State,IDAES,General framework for Helmholtz equation of state models.,,,,,,,,,idaes/models/properties/helmholtz/helmholtz.py,,,,, +Helmholtz Equation of State: IAPWS95,IDAES,IAPWS95 property package for water and steam.,,,,,,,,Iapws95ParameterBlock,idaes/models/properties/iapws95.py,,,,, +Henry's Law,IDAES,Methods for calculating fugacity of Henry's Law components.,,,,,,,,,idaes/models/properties/modular_properties/phase_equil/henry.py,,,,, +High-Rate Contact Stabilization (ZO),WaterTAP,,,HRCSZO,watertap/unit_models/zero_order/hrcs_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +"Hydrocarbon processing phase equilibrium, Peng-Robinson ",IDAES,Hydrocarbon processing phase equilibrium package using Peng-Robinson EoS.,,,,,,,,,idaes/models/properties/modular_properties/examples/HC_PR.py,,,,, +"Hydrocarbon processing vapor phase, Peng-Robinson",IDAES,Hydrocarbon processing vapor phase package using Peng-Robinson EoS.,,,,,,,,,idaes/models/properties/modular_properties/examples/HC_PR_vap.py,,,,, +Hydrothermal Gasification (ZO),WaterTAP,,,HTGZO,watertap/unit_models/zero_order/hydrothermal_gasification_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Ideal Gases and Liquids,IDAES,Generic module for ideal gas and liquid properties,,,,,,,,,idaes/models/properties/modular_properties/eos,,,,, +Injection Well Disposal (ZO),WaterTAP,,,InjectionWellDisposalZO,watertap/unit_models/zero_order/injection_well_disposal_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Integrated Anaerobic Membrane Bioreactor/Microbial Electrolysis Cell (ZO),WaterTAP,,,AnaerobicMBRMECZO,watertap/unit_models/zero_order/anaerobic_mbr_mec_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Intrusion Mitigation (ZO),WaterTAP,,,IntrusionMitigationZO,watertap/unit_models/zero_order/intrusion_mitigation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Ion Exchange (0D),WaterTAP,,,IonExchange0D,watertap/unit_models/ion_exchange_0D.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +target_ion +regenerant +hazardous_waste +isotherm","Inlet feed state variables (temperature, pressure, component molar flowrate), resin bead diameter, resin bulk density, bed porosity, service flow rate or superficial velocity through bed, number of operational columns. +If isotherm is set to langmuir: Langmuir isotherm coefficient, resin maximum capacity, dimensionless time. +If isotherm is set to freundlich: Freundlich isotherm exponent, bed volumes of feed at breakthru concentration, dimensionless (relative) concentration of target ion, bed volumes of feed at 50 percent breakthrough or mass transfer coefficient for Clark model (kT).", +Ion Exchange (ZO),WaterTAP,,,IonExchangeZO,watertap/unit_models/zero_order/ion_exchange_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Iron And Manganese Removal (ZO),WaterTAP,,,IronManganeseRemovalZO,watertap/unit_models/zero_order/iron_and_manganese_removal_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Landfill (ZO),WaterTAP,,,LandfillZO,watertap/unit_models/zero_order/landfill_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Leaching,PrOMMiS,"The Leach Train unit model represents a series of leaching tanks in which a solid and liquid stream are contacted and +undergo heterogeneous chemical reactions.",,LeachingTrain,prommis/leaching/leach_train.py,,,,,LeachSolutionParameters (liquid); CoalRefuseParameters (solid),"prommis/leaching/leach_solids_properties prommis/leaching/leach_solution_properties; +prommis/src/prommis/solid_handling/crusher_solids_properties.py",CoalRefuseLeachingReactions,prommis/leaching/leach_reactions.py,number_of_tanks,"Liquid inlet flowrate and concentrations, solid inlet mass flowrate and fractions", +Low pressure pure component gas thermal conductivity,IDAES,Eucken correlation to calculate low pressure pure component gas thermal conductivity.,,,,,,,,,idaes/models/properties/modular_properties/pure/Eucken.py,,,,, +Magprex (ZO),WaterTAP,,,MagprexZO,watertap/unit_models/zero_order/magprex_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +"Mechanical Vapor Compression (MVC) +Flowsheet",WaterTAP,,,"Feed +Separator +Mixer +Product (x2; brine distillate) +Translator +HeatExchanger (x2; brine, distillate) +Evaporator +Compressor +Condenser +Pump (x3, feed, brine, distillate)","watertap/flowsheets/mvc/mvc_single_stage.py +idaes/models/unit_models/feed.py +idaes/models/unit_models/separator.py +idaes/models/unit_models/mixer.py +idaes/models/unit_models/product.py +idaes/models/unit_models/translator.py +idaes/models/unit_models/heat_exchanger.py +watertap/unit_models/mvc/components/evaporator.py +watertap/unit_models/mvc/components/compressor.py +watertap/unit_models/mvc/components/complete_condenser.py +watertap/unit_models/pressure_changer.py",,,,,"SeawaterParameterBlock (Liq phase) +WaterParameterBlock (Vap phase)","watertap/property_models/seawater_prop_pack.py +watertap/property_models/water_prop_pack.py",,,"Evaporator: +property_package_feed +property_package_args_feed +property_package_vapor +property_package_args_vapor +material_balance_type +energy_balance_type +momentum_balance_type +Compressor: +material_balance_type +energy_balance_type +momentum_balance_type +Condenser: +material_balance_type +energy_balance_type +momentum_balance_type","Inlet feed state variables (i.e, temperature, pressure, component flowrates and mass fractions). Evaporator: 1 outlet condition (brine or vapor temperature or pressure), overall heat transfer coefficient, area for heat exchange. Compressor: pressure ratio, work (control volume variable), isentropic efficiency. Pumps: pressure change across the inlet and outlet, pump efficiency. Heat exchangers: overall heat transfer coefficient, area for heat exchange, pressure change across the inlet and outlet.", +Media Filtration (ZO),WaterTAP,,,MediaFiltrationZO,watertap/unit_models/zero_order/media_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Membrane Aerated Biofilm Reactor (ZO),WaterTAP,,,MABRZO,watertap/unit_models/zero_order/mabr_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Membrane Bioreactor (ZO),WaterTAP,,,MBRZO,watertap/unit_models/zero_order/mbr_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Membrane Distillation (0D),WaterTAP,,,MembraneDistillation0D,watertap/unit_models/MD/membrane_distillation_0D.py,MembraneDistillationBaseData,watertap/unit_models/MD/membrane_distillation_base.py,MDChannel0DBlock,watertap/unit_models/MD/MD_channel_0D.py,"SeawaterParameterBlock +WaterParameterBlock +(Liq phase, vap phase)","watertap/property_models/seawater_prop_pack.py +watertap/property_models/water_prop_pack.py",,,"material_balance_type +energy_balance_type +momentum_balance_type +flow_direction +temperature_polarization_type +concentration_polarization_type +mass_transfer_coefficient +has_pressure_change +pressure_change_type +friction_factor +property_package_vapor +property_package_args_vapor +hot_ch +cold_ch +gap_ch +MD_configuration_Type","Hot channel and cold channel inlet state variables (i.e, temperature, pressure, and component flowrates), membrane permeability coefficient, membrane thickness, membrane thermal conductivity, recovery or membrane area. +Additional degrees of freedom for: VMD (Vacuum Membrane Distillation) configuration, pressure at the cold side; GMD (Permeate Gap/Conductive Gap Membrane Distillation) configuration, gap thermal conductivity and gap thickness. +If temperature polarization, concentration polarization, mass transfer coefficient is computed: hot channel spacer porosity, hot channel height, cold channel spacer porosity (in Direct Contact Membrane Distillation, DCMD, and GMD), cold channel height (in DCMD and GMD, membrane length or membrane width", +Membrane Distillation (1D),WaterTAP,,,MembraneDistillation1D,watertap/unit_models/MD/membrane_distillation_1D.py,MembraneDistillationBaseData,watertap/unit_models/MD/membrane_distillation_base.py,MDChannel1DBlock,watertap/unit_models/MD/MD_channel_1D.py,"SeawaterParameterBlock +WaterParameterBlock +(Liq phase, vap phase)","watertap/property_models/seawater_prop_pack.py +watertap/property_models/water_prop_pack.py",,,"material_balance_type +energy_balance_type +momentum_balance_type +flow_direction +temperature_polarization_type +concentration_polarization_type +mass_transfer_coefficient +has_pressure_change +pressure_change_type +friction_factor +property_package_vapor +property_package_args_vapor +hot_ch +cold_ch +gap_ch +MD_configuration_Type +area_definition +transformation_method +transformation_scheme +finite_elements +collocation_points","Hot channel and cold channel inlet state variables (i.e, temperature, pressure, and component flowrates), membrane permeability coefficient, membrane thickness, membrane thermal conductivity, recovery or membrane area. +Additional degrees of freedom for: VMD (Vacuum Membrane Distillation) configuration, vacuum pressure at the cold side; GMD (Permeate Gap/Conductive Gap Membrane Distillation) configuration, gap thermal conductivity and gap thickness. +If temperature polarization, concentration polarization, mass transfer coefficient is computed: hot channel spacer porosity, hot channel height, cold channel spacer porosity (in Direct Contact Membrane Distillation, DCMD, and GMD), cold channel height (in DCMD and GMD, membrane length or membrane width.", +Membrane Evaporator (ZO),WaterTAP,,,MembraneEvaporator,watertap/unit_models/zero_order/membrane_evaporator_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Microbial Battery (ZO),WaterTAP,,,MicrobialBattery,watertap/unit_models/zero_order/microbial_battery_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Microfiltration (ZO),WaterTAP,,,MicroFiltrationZO,watertap/unit_models/zero_order/microfiltration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Microscreen Filtration (ZO),WaterTAP,,,MicroscreenFiltrationZO,watertap/unit_models/zero_order/microscreen_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Mixer,IDAES,General purpose mixer block for IDAES models.,,Mixer,idaes/models/unit_models/mixer.py,,,,,,,,,,, +Mixture thermal conductivity of a low pressure gas,IDAES,Wassiljew-Mason-Saxena rules to obtain mixture thermal conductivity of a low pressure gas from component thermal conductivities.,,,,,,,,,idaes/models/properties/modular_properties/transport_properties/thermal_conductivity_wms.py,,,,, +Mixture viscosity of a low pressure gas,IDAES,"Wilke rules to obtain mixture viscosity of a low pressure gas from pure component +viscosities.",,,,,,,,,idaes/models/properties/modular_properties/transport_properties/viscosity_wilke.py,,,,, +Modular Encapsulated Two-stage Anaerobic Biological Reactor (ZO),WaterTAP,,,MetabZO,watertap/unit_models/zero_order/metab_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Multiple-stream contactor,IDAES,IDAES model for a generic multiple-stream contactor unit.,,MSContactor,idaes/models/unit_models/mscontactor.py,,,,,,,,,,, +Municipal Drinking (ZO),WaterTAP,,,MunicipalWaterZO,watertap/unit_models/zero_order/municipal_drinking_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Municipal Wastewater Treatment Plant (ZO),WaterTAP,,,MunicipalWWTPZO,watertap/unit_models/zero_order/municipal_wwtp_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Nanofiltration,PrOMMiS,"This is an example flowsheet for the separation of lithium and magnesium ions using nanofiltration (NF). The unit model is the Donnan Steric Pore Model with Dielectric Exclusion (DSPM-DE) and the property model is the Multi-Component Aqueous Solution (MCAS) property package, both of which can be found in WaterTAP. Currently, the inlet feed is modeling the Salar de Atacama brine. + +The objective of the Pyomo model is to limit the amount of lithium lost in the retentate stream, with 2 degrees of freedom (pressure, area). Operating at this extreme end of the tradeoff between the selectivity and permeability, combined with the low solvent flux for this example, the magnesium rejection is low (~14%). An additional constraint is enacted on the model to limit the feed pressure to 70 bar, per typical experimental capabilities. + +Good references for details on the NF model, i.e., the DSPM-DE model: https://doi.org/10.1021/acs.est.2c08584 ; https://doi.org/10.1016/j.memsci.2020.118809",prommis/nanofiltration/nf_brine.py,NanofiltrationDSPMDE0D; Pump,"watertap/unit_models/nanofiltration_DSPMDE_0D; +watertap/unit_models/pressure_changer",,,,,MCASParameterBlock,watertap/property_models/multicomp_aq_sol_prop_pack,,,,"Inlet flowrate and concentrations; pump efficiency, inlet temperature and pressure, and outlet pressure; nanofiltration recovery, spacer porosity, channel height, velocity, area, outlet pressure, spacer mixing efficiency, spacer mixing length, pore radius, membrane thickness, membrane charge density, dielectric constant ", +Nanofiltration (0D),WaterTAP,,,Nanofiltration0D,watertap/unit_models/nanofiltration_0D.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"momentum_balance_type +has_pressure_change +energy_balance_type +electroneutrality_ion +passing_species_list +default_passing_rejection +default_excluded_rejection","Inlet feed state variables (i.e, temperature, pressure, component molar flowrates), permeate pressure, solvent recovery fraction, solute rejection fractions for all solutes except the one identified as the electroneutrality species, membrane area, retentate pressure drop", +Nanofiltration (ZO),WaterTAP,,,NanofiltrationZO,watertap/unit_models/nanofiltration_ZO.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type +has_pressure_change","Inlet feed state variables (i.e, temperature, pressure, solvent and solute mass flowrates). Membrane's solvent volumetric flux rate, permeate pressure, membrane's solute rejection. If solutes are ionic and contain multiple ion pairs, one ion's rejection may be unfixed for electroneutrality. Another variable, such as volumetric recovery rate or membrane area, fixes the last degree of freedom.", +Nanofiltration (ZO),WaterTAP,,,NanofiltrationZO,watertap/unit_models/zero_order/nanofiltration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Nanofiltration- Donnan Steric Pore Model with Dielectric Exclusion (0D),WaterTAP,,,NanofiltrationDSPMDE0D,watertap/unit_models/nanofiltration_DSPMDE_0D.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +momentum_balance_type +has_pressure_change +mass_transfer_coefficient +concentration_polarization_type","Inlet feed state variables (i.e, temperature, pressure, component molar flowrates), pore radius, membrane effective thickness, membrane charge density, dielectric constant of medium (pore), permeate pressure, spacer porosity, channel height, crossflow velocity in feed channel, membrane area, mass transfer coefficient for each ion or spacer net mixing efficiency and spacer characteristic length for calculating mass transfer coefficient with spiral wound correlation", +Osmotically Assisted Reverse Osmosis (0D),WaterTAP,,,OsmoticallyAssistedReverseOsmosis0D,watertap/unit_models/osmotically_assisted_reverse_osmosis_0D.py,OsmoticallyAssistedReverseOsmosisBaseData,watertap/unit_models/osmotically_assisted_reverse_osmosis_base.py,MembraneChannel0DBlock,watertap/core/membrane_channel0d.py,"NaClParameterBlock +(Liq phase)",watertap/property_models/NaCl_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +concentration_polarization_type +mass_transfer_coefficient +transport_model +module_type +has_pressure_change +pressure_change_type +friction_factor +has_full_reporting","Feed-side and permeate-side inlet state variables (i.e, temperature, pressure, component mass flowrates), membrane area, membrane water permeability A, membrane salt permeability B, structural parameter (i.e., effective thickness). +If concentration polarization effects, mass transfer coefficient, and pressure drop are calculated: feed-side and permeate-side spacer porosity, channel height, and feed-side Reynolds number or water mass recovery. +If has_pressure_change is set to True: pressure drop. +If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: concentration polarization modulus in feed and permeate channels. +If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: mass transfer coefficient in feed and permeate channels. +If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type is not set to PressureChangeType.fixed_per_stage: membrane length. +If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side and permeate-side average pressure drop per unit length. +If pressure_change_type is set to PressureChangeType.calculated: friction factor, feed-side and permeate-side velocity and pressure drop per unit length.", +Osmotically Assisted Reverse Osmosis (1D),WaterTAP,,,OsmoticallyAssistedReverseOsmosis1D,watertap/unit_models/osmotically_assisted_reverse_osmosis_1D.py,OsmoticallyAssistedReverseOsmosisBaseData,watertap/unit_models/osmotically_assisted_reverse_osmosis_base.py,MembraneChannel1DBlock,watertap/core/membrane_channel1d.py,"NaClParameterBlock +(Liq phase)",watertap/property_models/NaCl_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +concentration_polarization_type +mass_transfer_coefficient +transport_model +module_type +has_pressure_change +pressure_change_type +friction_factor +area_definition +transformation_method +transformation_scheme +finite_elements +collocation_points +has_full_reporting","Feed-side and permeate-side inlet state variables (i.e, temperature, pressure, component mass flowrates), membrane area, membrane water permeability A, membrane salt permeability B, structural parameter (i.e., effective thickness). +If concentration polarization effects, mass transfer coefficient, and pressure drop are calculated: feed-side and permeate-side spacer porosity, channel height, and feed-side Reynolds number or water mass recovery. +If has_pressure_change is set to True: pressure drop. +If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: concentration polarization modulus in feed and permeate channels. +If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: mass transfer coefficient in feed and permeate channels. +If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type is not set to PressureChangeType.fixed_per_stage: membrane length and width. +If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side and permeate-side average pressure drop per unit length. +If pressure_change_type is set to PressureChangeType.calculated: friction factor, feed-side and permeate-side velocity and pressure drop per unit length.", +Oxalate roaster,PrOMMiS,"REE Oxalate Roaster is a unit operation to convert oxalates of rare earth and gangue metal +elements to metal oxides through thermal decomposition and oxidation. There are 18 rare earth elements +including `Sc`, `Y`, `La`, `Ce`, `Pr`, `Nd`, `Pm`, `Sm`, `Eu`, `Gd`, `Tb`, `Dy`, `Ho`, `Er`, `Tm`, `Yb`, `Lu`, +and `Th` in the model. The user can specify a subset of those 18 elements through configuration when creating +the unit model. The 3 gangue elements considered in the model are `Fe`, `Al`, and `Ca`. + +The feed oxalate mixture stream is typically from a precipitator in an upstream process. It is assumed +that all oxalates are in their hydrate forms. In case the anhydrous oxalate feed flow rates are specified in +the property package of the solid feed stream, the molar flow rates are converted to the corresponding hydrate flow rates. +The molecular formula of an oxalate hydrate can be expressed in a general form as :ce:`RE2(C2O4)3 \\cdot xH2O` where RE is +one of the 18 rare earth elements and x is the number of water molecules associated with the hyrate. The three +gangue oxalate hydrates considered in the model are :ce:`Fe2(C2O4)3 \\cdot 2H2O`, :ce:`Al2(C2O4)3 \\cdot H2O`, and +:ce:`CaC2O4 \\cdot H2O`, for `Fe`, `Al`, and `Ca` elements, respectively. + +The feed stream contains surface moisture. The amount of surface moisture entering the reactor is specified by +a liquid inlet that contains a fraction of the liquid outlet of the precipitator.",,REEOxalateRoaster,prommis/roasting/ree_oxalate_roaster,,,,,"GenericParameterBlock (gas); +CoalRefuseParameters (solid); +AqueousParameter (liquid)","idaes/models/properties/modular_properties/base/generic_property; +prommis/leaching/leach_solution_properties; +prommis/precipitate/precipitate_liquid_properties",,,has_holdup; has_heat_transfer; has_pressure_change; metal_list,"Pressure drop, gas inlet temperature, pressure, mole flowrate, and mole fractions, gas outlet temperature, solid inlet temperature and mole flowrate, liquid inlet flowrate and concentrations, recovery fraction", has_heat_transfer +Ozone (ZO),WaterTAP,,,OzoneZO,watertap/unit_models/zero_order/ozone_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Ozone with Advanced Oxidation Processes (ZO),WaterTAP,,,OzoneAOPZO,watertap/unit_models/zero_order/ozone_aop_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Peracetic Acid Disinfection (ZO),WaterTAP,,,PeraceticAcidDisinfection,watertap/unit_models/zero_order/peracetic_acid_disinfection_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Phase equilibrium ,IDAES,Library of common forms for phase equilibrium constraints.,,,,,,,,,idaes/models/properties/modular_properties/phase_equil/forms.py,,,,, +Photothermal Membrane (ZO),WaterTAP,,,PhotothermalMembrane,watertap/unit_models/zero_order/photothermal_membrane_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Plug flow reactor,IDAES,Standard IDAES plug flow reactor model.,,PFR,idaes/models/unit_models/plug_flow_reactor.py,,,,,,,,,,, +Precipitate,PrOMMiS,The Precipitator Unit Model represents an Equilibrium reactor unit model with fixed partition coefficients.,,Precipitator,prommis/precipitate/precipitator,,,,,AqueousParameter (aqueous); PrecipitateParameters (precipitate).,prommis/precipitate/precipitate_liquid_properties prommis.precipitate.precipitate_solids_properties,,,,"Aqueous inlet flowrate and concentrations, percipitate temperature", +Pressure changer,IDAES,Standard IDAES pressure changer model.,,PressureChanger,idaes/models/unit_models/pressure_changer.py,,,,,,,,,,, +Pressure Exchanger,WaterTAP,,,PressureExchanger,watertap/unit_models/pressure_exchanger.py,,,,,"SeawaterParameterBlock +MCASParameterBlock +(Liq phase)","watertap/property_models/seawater_prop_pack.py +watertap/property_models/multicomp_aq_sol_prop_pack.py",,,"material_balance_type +is_isothermal +energy_balance_type +momentum_balance_type +has_leakage +has_mixing +pressure_exchange_calculation","Feed-side and brine-side state variables (i.e., temperature, pressure, volumetric flowrate, mass fraction), pressure exchanger efficiency. +If has_mixing is set to True: volumetric mixing fraction of the brine side and feed side. +If has_leakage is set to True: volumetric leakage fraction of the brine side to the feed side. +If pressure_exchange_calculation configuration option is set to PressureExchangeType.high_pressure_difference: high pressure difference, low pressure difference, and the pressure exchanger efficiency is unfixed.", +Primary Separator (ZO),WaterTAP,,,PrimarySeparatorZO,watertap/unit_models/zero_order/primary_separator_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Product,IDAES,Standard IDAES Product block.,,Product,idaes/models/unit_models/product.py,,,,,,,,,,, +Properties interrogator,IDAES,"Tool to interrogate IDAES flowsheets and list the physical properties +required to simulate it.",,,,,,,,PropertyInterrogatorBlock,idaes/models/properties/interrogator/properties_interrogator.py,,,,, +Pump,WaterTAP,,,Pump,watertap/unit_models/pressure_changer.py,"Pressure changer, PressureChanger -> Pump, Pump",idaes/models/unit_models/pressure_changer.py,,,"SeawaterParameterBlock +MCASParameterBlock +(Liq phase)","watertap/property_models/seawater_prop_pack.py +watertap/property_models/multicomp_aq_sol_prop_pack.py",,,"material_balance_type +energy_balance_type +momentum_balance_type +has_phase_equilibrium +compressor +thermodynamic_assumption +support_isentropic_performance_curves +isentropic_performance_curves +isentropic_performance_curves (build_callback, build_head_expressions) +variable_efficiency +bep_flow* +bep_eta* +flow_ratio* +*When variable_efficiency is not VariableEfficiency.none","Outlet pressure or pressure change across the inlet and outlet, pump efficiency", +Pump,IDAES,Pump model.,,Pump,idaes/models/unit_models/pressure_changer.py,,,,,,,,,,, +Pump (ZO),WaterTAP,,,PumpZO,watertap/unit_models/zero_order/pump_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Pump Electricity (ZO),WaterTAP,,,PumpElectricityZO,watertap/unit_models/zero_order/pump_electricity_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Pure component electrolyte methods,IDAES,Method for constant relative permittivity.,,,,,,,,,idaes/models/properties/modular_properties/pure/electrolyte.py,,,,, +Pure component gas viscosities at low pressures,IDAES,"Pure component gas viscosities at low pressures from critical properties, +acentric factor, and dipole moment.",,,,,,,,,idaes/models/properties/modular_properties/pure/ChungPure.py,,,,, +Pure component properties,IDAES,"Methods for calculating pure component properties from: The Properties of Gases & Liquids, 4th Edition Reid, Prausnitz and Polling, 1987, McGraw-Hill.",,,,,,,,,idaes/models/properties/modular_properties/pure/RPP4.py,,,,, +Pure component properties,IDAES,"Methods for calculating pure component properties from: The Properties of Gases & Liquids, 3rd Edition Reid, Prausnitz and Polling, 1977, McGraw-Hill.",,,,,,,,,idaes/models/properties/modular_properties/pure/RPP3.py,,,,, +Pure component properties,IDAES,Methods for calculating pure component properties from: Perry's Chemical Engineers' Handbook.,,,,,,,,,idaes/models/properties/modular_properties/pure/Perrys.py,,,,, +Pure component properties,IDAES,Pure component properties as used by the NIST WebBook.,,,,,,,,,idaes/models/properties/modular_properties/pure/NIST.py,,,,, +Pure component properties,IDAES,"Methods for calculating pure component properties from: The Properties of Gases & Liquids, 5th Edition Reid, Prausnitz and Polling, 2001, McGraw-Hill.",,,,,,,,,idaes/models/properties/modular_properties/pure/RPP5.py,,,,, +Reaction equilibrium constants,IDAES,Methods for calculating equilibrium constants.,,,,,,,,,,,idaes/models/properties/modular_properties/reactions/equilibrium_constant.py,,, +Reaction rate constants,IDAES,Methods for calculating rate constants.,,,,,,,,,,,idaes/models/properties/modular_properties/reactions/rate_constant.py,,, +Reaction rates,IDAES,Methods for defining reaction rates.,,,,,,,,,,,idaes/models/properties/modular_properties/reactions/rate_forms.py,,, +Reactions interrogator,IDAES,Tool to interrogate IDAES flowsheets and list the reaction properties required to simulate it.,,,,,,,,,,ReactionInterrogatorBlock,idaes/models/properties/interrogator/reactions_interrogator.py,,, +Recirculating Dynamic Membrane Bioreactor (ZO),WaterTAP,,,DMBRZOO,watertap/unit_models/zero_order/dmbr_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +REE processing plant,PrOMMiS,"The University of Kentucky (UKy) rare earth element (REE) processing plant is designed to extract salable rare earth oxides from domestic U.S. coal and coal byproducts. While this implementation of the plant does not take into account +all of the complexities and unit processes detailed in the 2019 report, it depicts the major phenomena by utilizing a series of conventional REE extraction techniques, including acid tank leaching, solvent extraction, precipitation, and product roasting.",prommis/uky/uky_flowsheet.py,LeachingTrain; Precipitator; REEOxalateRoaster; SolventExtraction; SLSeparator; Mixer;Separator,"prommis/leaching/leach_train; +prommis/precipitate/precipitator; +prommis/roasting/ree_oxalate_roaster; +prommis/solvent_extraction/solvent_extraction; +idaes/models/unit_models/solid_liquid; +idaes/models/unit_models/mixer; +idaes/models/unit_models/separator",,,,,LeachSolutionParameters (liquid); CoalRefuseParameters (solid); AqueousParameter (aqueous); PrecipitateParameters (precipitate); REESolExOgParameters (organic); GenericParameterBlock (gas),"prommis/leaching/leach_solids_properties; +prommis/leaching/leach_solution_properties; +prommis/precipitate/precipitate_liquid_properties; +prommis/precipitate/precipitate_solids_properties; +prommis/solvent_extraction/ree_og_distribution; +idaes/models/properties/modular_properties/base/generic_property",CoalRefuseLeachingReactions,prommis/leaching/leach_reactions,,"Leach liquid inlet flowrate and concentrations, leach solid inlet mass flowrateand fractions, leach volume; rougher makeup stream flowrate and concentrations; acid feeds (3) flowrate and concentrations; cleaner make-up stream flowrate and concentrations; separators split fraction; sl separators liquid recovery; precipitate temperature; roaster pressure drop, roaster gas inlet temperature, pressure, mole flowrate and fraction, roaster gas outlet temperature, roaster recovery fraction", CoalRefuseParameters (solid) +Reverse Osmosis (0D),WaterTAP,,,ReverseOsmosis0D,watertap/unit_models/reverse_osmosis_0D.py,ReverseOsmosisBaseData,watertap/unit_models/reverse_osmosis_base.py,MembraneChannel0DBlock,watertap/core/membrane_channel0d.py,"NaClParameterBlock +(Liq phase)",watertap/property_models/NaCl_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +concentration_polarization_type +mass_transfer_coefficient +transport_model +module_type +has_pressure_change +pressure_change_type +friction_factor +has_full_reporting","Inlet feed state variables (i.e., temperature, pressure, component flowrates), membrane area, membrane water permeability A, membrane salt permeability B, and permeate pressure. +If concentration polarization effects, mass transfer coefficient, and pressure drop are calculated: feed spacer porosity, feed channel height, and membrane length or membrane width or inlet Reynolds number. +If has_pressure_change is set to True: pressure drop. +If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: concentration polarization modulus in feed channel. +If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: mass transfer coefficient in feed channel. +If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type is set to PressureChangeType.calculated: feed channel height, hydraulic diameter, spacer porosity, Reynolds number. +If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type is not set to PressureChangeType.fixed_per_stage: membrane length and width. +If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side average pressure drop per unit length. +If pressure_change_type is set to PressureChangeType.calculated: friction factor, feed-side velocity, and pressure drop per unit length. +If transport_model is set to TransportModel.SKK (Speigler-Kedem-Katchalsky model): reflection coefficient, alpha.", +Reverse Osmosis (1D),WaterTAP,,,ReverseOsmosis1D,watertap/unit_models/reverse_osmosis_1D.py,ReverseOsmosisBaseData,watertap/unit_models/reverse_osmosis_base.py,MembraneChannel0DBlock,watertap/core/membrane_channel0d.py,"NaClParameterBlock +(Liq phase)",watertap/property_models/NaCl_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +concentration_polarization_type +mass_transfer_coefficient +transport_model +module_type +has_pressure_change +pressure_change_type +friction_factor +area_definition +transformation_method +transformation_scheme +finite_elements +collocation_points +has_full_reporting","Inlet feed state variables (i.e., temperature, pressure, component flowrates), membrane area, membrane water permeability A, membrane salt permeability B, permeate pressure, and membrane area or length or width. +If concentration polarization effects, mass transfer coefficient, and pressure drop are calculated: feed spacer porosity, feed channel height, and membrane length or membrane width or inlet Reynolds number. +If has_pressure_change is set to True: pressure drop. +If concentration_polarization_type is set to ConcentrationPolarizationType.fixed: concentration polarization modulus in feed channel. +If concentration_polarization_type is set to ConcentrationPolarizationType.calculated: mass transfer coefficient in feed channel. +If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type is set to PressureChangeType.calculated: feed channel height, hydraulic diameter, spacer porosity, Reynolds number. +If mass_transfer_coefficient is set to MassTransferCoefficient.calculated or pressure_change_type is not set to PressureChangeType.fixed_per_stage: membrane length and width. +If pressure_change_type is set to PressureChangeType.fixed_per_unit_length: Feed-side average pressure drop per unit length. +If pressure_change_type is set to PressureChangeType.calculated: friction factor, feed-side and permeate-side velocity and pressure drop per unit length. +If transport_model is set to TransportModel.SKK (Speigler-Kedem-Katchalsky model): reflection coefficient, alpha.", +Saponification reactions,IDAES,Example property package for the saponification of Ethyl Acetate with NaOH.,,,,,,,,,,SaponificationReactionParameterBlock,idaes/models/properties/examples/saponification_reactions.py,,, +Saponification thermo,IDAES,Example property package for the saponification of Ethyl Acetate with NaOH (simple liquid phase properties).,,,,,,,,SaponificationParameterBlock,idaes/models/properties/examples/saponification_thermo.py,,,,, +Screen (ZO),WaterTAP,,,ScreenZO,watertap/unit_models/zero_order/screen_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Seawater Onshore Intake (ZO),WaterTAP,,,SWOnshoreIntakeZO,watertap/unit_models/zero_order/sw_onshore_intake_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Secondary Wastewater Treatment Plant (ZO),WaterTAP,,,SecondaryTreatmentWWTPZO,watertap/unit_models/zero_order/secondary_treatment_wwtp_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Sedimentation (ZO),WaterTAP,,,SedimentationZO,watertap/unit_models/zero_order/sedimentation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Separator,IDAES,General purpose separator block for IDAES models.,,Separator,idaes/models/unit_models/separator.py,,,,,,,,,,, +Settling Pond (ZO),WaterTAP,,,SettlingPondZO,watertap/unit_models/zero_order/settling_pond_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Shell and tube heat exchanger,IDAES,1D Single pass shell and tube HX model with 0D wall conduction model.,,ShellAndTube1D,idaes/models/unit_models/shell_and_tube_1d.py,,,,,,,,,,, +Skeleton model,IDAES,Skeleton unit model that provides users with a generic skeleton to add a custom or a surrogate unit model when control volumes are not required.,,SkeletonUnitModel,idaes/models/unit_models/skeleton_model.py,,,,,,,,,,, +Sludge Tank (ZO),WaterTAP,,,SludgeTankZO,watertap/unit_models/zero_order/sludge_tank_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +SMP (ZO),WaterTAP,,,SMPZO,watertap/unit_models/zero_order/smp_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Solid-liquid separator,IDAES,Base model for solid-liquid separations.,,SLSeparator,"idaes/models/unit_models/solid_liquid +/sl_separator.py",,,,,,,,,,, +Solvent extraction,PrOMMiS,"The Solvent Extraction unit model is used to perform the solvent extraction unit operation. It represents a series of tanks, referred to as stages, through which the aqueous and organic phases are passed, and the desired components are extracted subsequently.",,SolventExtraction,prommis/solvent_extraction/solvent_extraction,,,,,LeachSolutionParameters (aqueous); REESolExOgParameters (organic).,prommis/leaching/leach_solids_properties prommis.solvent_extraction.ree_og_distribution,,,number_of_finite_elements,"Aqueous inlet flowrate and concentrations, solid inlet mass flowrate and concentrations", +Square flash formulation,IDAES,"A smooth, square flash formulation for equation-oriented flowsheet optimization.",,,,,,,,,idaes/models/properties/modular_properties/phase_equil/smooth_VLE.py,,,,, +State junction ,IDAES,Standard IDAES StateJunction model.,,StateJunction,idaes/models/unit_models/statejunction.py,,,,,,,,,,, +Static Mixer (ZO),WaterTAP,,,StaticMixerZO,watertap/unit_models/zero_order/static_mixer_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Steam Jet Ejector,WaterTAP,,,SteamEjector,watertap/unit_models/steam_ejector.py,,,,,"WaterParameterBlock (Liq phase, vap phase)",watertap/property_models/water_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type","Inlet state variables (i.e., temperature, pressure, and component flowrates for motive steam and entrained vapor). Entrainment ratio, compression ratio.", +Stoichiometric reactor,IDAES,Standard IDAES STOICHIOMETRIC reactor model,,StoichiometricReactor,idaes/models/unit_models/stoichiometric_reactor.py,,,,,,,,,,, +Stoichiometric reactor,WaterTAP,,,StoichiometricReactor,watertap/unit_models/stoichiometric_reactor.py,,,,,MCASParameterBlock (Liq phase),watertap/property_models/multicomp_aq_sol_prop_pack.py,,,"material_balance_type +energy_balance_type +momentum_balance_type +has_pressure_change +reagent +precipitate","Inlet state variables (i.e., temperature, pressure, component mass compositions). If reagents are supplied: reagent mass flow rate or reagent dose. If precipitants are supplied: precipitant mass flow rate, mass fraction of solids in precipitant (solid) waste stream.", +Storage Tank (ZO),WaterTAP,,,StorageTankZO,watertap/unit_models/zero_order/storage_tank_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Stream scaler,IDAES,"Unit model to adjust size of streams to represent, for example, a stream being split across several identical units, which are then all modeled as a single IDAES unit.",,StreamScaler,idaes/models/unit_models/stream_scaler.py,,,,,,,,,,, +Struvite Classifier (ZO),WaterTAP,,,StruviteClassifierZO,watertap/unit_models/zero_order/struvite_classifier_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Suboxic Activated Sludge Process (ZO),WaterTAP,,,SuboxicASMZO,watertap/unit_models/zero_order/suboxic_activated_sludge_process_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Supercritical Salt Precipitation (ZO),WaterTAP,,,SaltPrecipitationZO,watertap/unit_models/zero_order/supercritical_salt_precipitation_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Surface Discharge (ZO),WaterTAP,,,SurfaceDischarge,watertap/unit_models/zero_order/surface_discharge_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Thickener,WaterTAP,,,Thickener,watertap/unit_models/thickener.py,"Separator, Separator",idaes/models/unit_models/separator.py,,,"ASM1ParameterBlock +ASM2dParameterBlock +ModifiedASM2dParameterBlock +(Single Liq phase)","watertap/property_models/unit_specific/activated_sludge/asm1_properties.py +watertap/property_models/unit_specific/activated_sludge/asm2d_properties.py +watertap/property_models/unit_specific/activated_sludge/modified_asm2d_properties.py",,,"outlet_list +num_outlets (not used if outlet_list arg is provided) +split_basis +material_balance_type +momentum_balance_type +has_phase_equilibrium +energy_split_basis +ideal_separation +ideal_split_map +mixed_state_block +construct_ports +activated_sludge_model","Inlet feed state variables (i.e., temperature, pressure, component mass compositions, alkalinity, volumetric flowrate).", +Thickener,IDAES,Thickener unit model.,,Thickener0D,"idaes/models/unit_models/solid_liquid +/thickener.py",,,,,,,,,,, +Tramp Oil Tank (ZO),WaterTAP,,,TrampOilTankZO,watertap/unit_models/zero_order/tramp_oil_tank_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Translator,IDAES,Generic template for a translator block.,,Translator,idaes/models/unit_models/translator.py,,,,,,,,,,, +Tri Media Filtration (ZO),WaterTAP,,,TriMediaFiltrationZO,watertap/unit_models/zero_order/tri_media_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Turbine,IDAES,Isentropic turbine model.,,Turbine,idaes/models/unit_models/pressure_changer.py,,,,,,,,,,, +Ultra Filtration (ZO),WaterTAP,,,UltraFiltrationZO,watertap/unit_models/zero_order/ultra_filtration_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Ultraviolet Advanced Oxidation Process,WaterTAP,,,Ultraviolet0D,watertap/unit_models/uv_aop.py,,,,,"NDMAParameterBlock +MCASParameterBlock","watertap/property_models/unit_specific/NDMA_prop_pack.py +watertap/property_models/multicomp_aq_sol_prop_pack.py",,,"material_balance_type +energy_balance_type +momentum_balance_type +has_pressure_change +uv_dose_type +has_aop +target_species","Inlet feed state variables (i.e., temperature, pressure, component mass flowrates). +If the uv_dose_type configuration option is set to default UVDoseType.fixed and the has_aop configuration is set to default False (5 DOF): Inactivation rate coefficient or overall pseudo-first order rate constant; two variables out of UV dose, average intensity of UV light, exposure time of UV light; either electricity demand of components with phase or electrical efficiency; and lamp efficiency. +Pseudo-first order rate constant for indirect photolysis of component is fixed to 0 when has_aop configuration is set to default False. +If the uv_dose_type configuration option to UVDoseType.calculated (7 additional DOF, 12 DOF in total): UV transmittance; coefficients A, B, C , D; relative lamp output; number of banks. +If has_aop is set to True (2 additional DOF, 7 DOF in total): second-order reaction rate constant; steady-state concentration of hydrogen peroxide.", +UV Reactor (ZO),WaterTAP,,,UVZO,watertap/unit_models/zero_order/uv_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +UV with Advanced Oxidation Processes (ZO),WaterTAP,,,UVAOPZO,watertap/unit_models/zero_order/uv_aop_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Valve,IDAES,Standard valve models for adiabatic control valves.,,Valve,idaes/models/unit_models/valve.py,,,,,,,,,,, +Volatile Fatty Acid (VFA) Recovery Unit (ZO),WaterTAP,,,VFARecoveryZO,watertap/unit_models/zero_order/vfa_recovery_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Walnut Shell Filter (ZO),WaterTAP,,,WalnutShellFilterZO,watertap/unit_models/zero_order/walnut_shell_filter_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Water Pumping Station (ZO),WaterTAP,,,WaterPumpingStationZO,watertap/unit_models/zero_order/water_pumping_station_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric +fix_pump_power",, +Well Field (ZO),WaterTAP,,,WellFieldZO,watertap/unit_models/zero_order/well_field_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, +Wind-Aided Intensified Evaporation Unit (ZO),WaterTAP,,,WAIVZO,watertap/unit_models/zero_order/waiv_zo.py,,,,,"WaterParameterBlock +(Liq phase)",watertap/property_models/water_prop_pack.py,,,"database +process_subtype +isothermal +isobaric",, \ No newline at end of file diff --git a/data/products.csv b/data/products.csv new file mode 100644 index 0000000..ea57650 --- /dev/null +++ b/data/products.csv @@ -0,0 +1,13 @@ +Name,Description,github,pypi,conda-forge,Projects,Interface,Links +Pyomo,"Pyomo is an open-source Python package for modeling and solving equation-oriented optimization problems, enabling users to define variables, constraints, and objectives and solve them using various solvers, including LP, NLP, and MILP.",Pyomo/pyomo,pyomo,pyomo,,Python API, +FOQUS,Framework for Optimization and Uncertainty Quantification,CCSI-Toolset/FOQUS,ccsi-foqus,,CCSI2,Graphical (GUI), +IDAES-PSE,IDAES core Python framework and model library,IDAES/idaes-pse,idaes-pse,idaes-pse,IDAES,Python API, +WaterTAP,WaterTAP core model library,watertap-org/watertap,watertap,,WaterTAP,Python API, +Parameter Sweep,"Toolkit to solve Pyomo models multiple times with different values for parameters, optionally in parallel",watertap-org/parameter-sweep,parameter-sweep,,"WaterTAP,PrOMMiS",Python API, +PrOMMiS,PrOMMiS model library,prommis/prommis,prommis,,PrOMMiS,Python API, +WaterTAP-REFLO,An extension of WaterTAP that incorporates renewable energy (RE) models for RE-driven desalination systems,watertap-org/reflo,,,WaterTAP,Python API, +Flowsheet Processor,API for exporting flowsheets to the Flowsheet Processor UI,prommis/idaes-flowsheet-processor,idaes-flowsheet-processor,,"IDAES,PrOMMiS,WaterTAP",Python API, +Flowsheet Processor UI,Graphical UI for configuring and running any IDAES flowsheet,prommis/idaes-flowsheet-processor-ui,,,"IDAES,WaterTAP,PrOMMiS",, +IDAES Flowsheet UI,"Self-contained, one-click-installer graphical application for interacting with IDAES flowsheets",,,,"IDAES,PARETO",Graphical (GUI), +WaterTAP Flowsheet UI,"Self-contained, one-click-installer graphical application for interacting with WaterTAP flowsheets",,,,"WaterTAP,PARETO",Graphical (GUI), +PrOMMiS Flowsheet UI,"Self-contained, one-click-installer graphical application for interacting with PrOMMiS flowsheets",,,,"PrOMMiS,PARETO",Graphical (GUI), \ No newline at end of file diff --git a/data/projects.csv b/data/projects.csv new file mode 100644 index 0000000..f90b155 --- /dev/null +++ b/data/projects.csv @@ -0,0 +1,8 @@ +Name,Description,Notes,Keywords,products,Homepage,Development +CCSI2,Carbon Capture Simulation for Industry Impact,,"carbon capture,simulation,modeling,optimization,uncertainty quantification",FOQUS,https://netl.doe.gov/carbon-management/carbon-capture/ccsi2,Active +IDAES,Institute for the Design of Advanced Energy Systems,,equation oriented,"IDAES-PSE,Flowsheet Processor,Flowsheet Processor UI,IDAES Flowsheet UI",https://idaes.org,Active +PARETO,Produced Water Initiative,,"produced water,optimization","PrOMMiS Flowsheet UI,WaterTAP Flowsheet UI,IDAES Flowsheet UI",https://project-pareto.org,Active +PrOMMiS,Process Optimization and Modeling for Minerals Sustainability,,"critical minerals,rare earth elements","Parameter Sweep,Flowsheet Processor,PrOMMiS,Flowsheet Processor UI,PrOMMiS Flowsheet UI",https://netl.doe.gov/prommis,Active +Pyomo,"Python-based, open-source optimization modeling language ",,"equation oriented,optimization",,https://www.pyomo.org/,Active +WaterTAP,Water treatment Techno-economic Analysis Platform,,"water treatment,water chemistry,techno-economic analysis","WaterTAP,Parameter Sweep,WaterTAP-REFLO,Flowsheet Processor,Flowsheet Processor UI,WaterTAP Flowsheet UI",https://watertap.readthedocs.io,Active +DISPATCHES,Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems,,"grid,hybrid energy systems",,https://dispatches.readthedocs.io,Archived \ No newline at end of file diff --git a/data/ui_products.csv b/data/ui_products.csv new file mode 100644 index 0000000..f13d990 --- /dev/null +++ b/data/ui_products.csv @@ -0,0 +1,8 @@ +Name,Description,Repository,Documentation,Features,Attachment Summary,ModelCompatibility +Flowsheet Processor,Run IDAES flowsheets with no coding and view graphical results.,https://github.com/prommis/idaes-flowsheet-processor-ui,https://prommis.github.io/idaes-flowsheet-processor-ui/,"Cross-platform GUI can run on Windows, MacOS, or Linux; Easily configure and run an IDAES model with graphical UI; Run in IDAES, WaterTAP or PrOMMiS mode, which loads default flowsheets for chosen project; Runs the model once or in a parameter sweep; Compare run results; Tabular and graphical results. Export to CSV (for Excel, etc.)","The document describes a cross-platform graphical user interface (GUI) compatible with Windows, MacOS, and Linux, designed to configure and run IDAES models. It supports operation in IDAES, WaterTAP, or PrOMMiS modes, each loading default flowsheets for the selected project. Users can execute single model runs or parameter sweeps, compare results, and view outputs in both tabular and graphical formats. Results can be exported to CSV for further analysis in tools like Excel.",IDAES +Flowsheet Visualizer,Visualize IDAES flowsheets and run diagnostics interactively.,https://github.com/IDAES/idaes-ui,https://idaes-ui.readthedocs.io/en/latest/user/fv/,"Cross-platform GUI can run on Windows, MacOS, or Linux; Visualize arbitrary flowsheets from a script or Jupyter Notebook; Flowsheet diagram can be rearranged and saved; Stream table is shown automatically, and linked to streams in the diagram; +Diagnostics toolkit is accessible through the UI",,IDAES +Flowsheet Connectivity,Quickly create visual diagrams showing the connectivity of flowsheet units and streams. ,https://github.com/prommis/idaes-connectivity,https://prommis.github.io/idaes-connectivity/,"Python library to generate connectivity data in useful formats; Run from command-line, script, or Jupyter Notebook;View connectivity in text-based diagrams Mermaid or D2; Add unit names, stream names, and user-defined annotations; Export connectivity as a table (CSV) for re-use in other tools",,"Pyomo,IDAES" +Superstructure UI,"Create specific classes of superstructures, for decision support, with a drag-and-drop UI.",https://github.com/prommis/prommis-ui,,"Create superstructures composed of feedstock, processing stages, and target products with a drag-and-drop UI; Add units to processing stages, configuring performance and cost of each; Connect processing units between adjacent stages; Run optimization and determine optimal connections for cost objective",,Custom +PARETO UI,Run and modify optimization analyses of produced water networks created under the Produced Water Optimization Initiative (PARETO). PARETO provides advanced _decision support_  solutions for the disposition of produced water from onshore oil & gas operations which are intuitive and accessible to field and system engineers.,https://www.project-pareto.org,,"Adaptable to a wide variety of technologies and geographies; Future integrations with subsurface modeling, orphan wells plugging, optimization, and other related solutions; Cross-platform graphical UI for Windows, MacOS, and Linux, with one-click install; Table-based inputs, editable in Excel or in the tool, specifying water source/sink/etc. details; Optimization step with ""override"" to take advantage of field operator knowledge",,Custom +FOQUS,Enabling advanced Process Systems Engineering (PSE) capabilities to be integrated with commercial process simulation software.,https://github.com/CCSI-Toolset/FOQUS,https://foqus.readthedocs.io/,Cross-platform desktop UI (PyQT); Integration of models from process simulators (SimSinter); Derivative-free optimization (DFO) with Turbine; Algebraic surrogate models to support large-scale deterministic optimization; Uncertainty Quantification (UQ); Optimization Under Uncertainty (OUU) for scenario-based optimization; Sequential Design of Experiments (SDoE),,"Custom,Pyomo" \ No newline at end of file diff --git a/update_data.py b/update_data.py index 2872dd0..9287f33 100644 --- a/update_data.py +++ b/update_data.py @@ -3,11 +3,12 @@ """ import argparse +import csv import json import logging import os from pathlib import Path -import requests +import re import sys import traceback from typing import Any @@ -18,214 +19,201 @@ __author__ = "Dan Gunter (LBNL)" -TOKENV = "IDAES_AIRTABLE_APIKEY" - -_log = logging.getLogger("idaes_airtable") +_log = logging.getLogger("idaes_plus") _h = logging.StreamHandler() _h.setFormatter(logging.Formatter("%(levelname)s %(name)s %(asctime)s - %(message)s")) _log.addHandler(_h) -class IdaesplusAirtable: - url = "https://api.airtable.com/v0" - baseid = "appcXhVXfV2YOYrrM" +class IdaesplusTables: table_names = ("projects", "products", "models", "ui_products") screenshots = None sshot_path = Path(__file__).parent / "screenshots.yaml" + data_path = Path(__file__).parent / "data" + + def __init__(self, continue_on_error: bool = False): + self._tables, self._report = {}, {} + self._soldier_on = continue_on_error + self._build_tables() - def __init__(self, tok): - self._tok = tok + @property + def report(self): + return self._report - def get_tables(self): - tables = {} + def _build_tables(self): for table_name in self.table_names: - url = f"{self.url}/{self.baseid}/{table_name}" - _log.debug(f"Begin:Request url={url}") - d = requests.get(url, headers={"Authorization": f"Bearer {self._tok}"}) - _log.debug(f"End:Request url={url} ; status={d.status_code}") - if d.status_code != 200: - if d.status_code == 401: - raise RuntimeError(f"Unauthorized. Check your API key") - else: - raise RuntimeError(f"Fetching '{url}': HTTP status {d.status_code}") - tables[table_name] = d.json()["records"] - return tables + csv_file = self.data_path / f"{table_name}.csv" + cur_table = [] + with csv_file.open("r") as f: + csv_table = csv.reader(f) + norm_header = None + for i, row in enumerate(csv_table): + if norm_header is None: + norm_header = [ + # not sure why \ufeff is appearing but whatevs + key.lower().replace(" ", "_").replace("\ufeff", "") + for key in row + ] + continue + fields = {norm_header[i]: row[i] for i in range(len(row))} + try: + getattr(self, f"_post_{table_name}")(table_name, fields) + except: + _log.error( + f"Postprocessing error in line {i + 1} of {csv_file}" + ) + raise + cur_table.append(fields) + self._tables[table_name] = cur_table + self._report[table_name] = {"records": len(cur_table)} - @classmethod - def dump_tables(cls, path, tables): - report = {} - y = {} - for table_name, table_contents in tables.items(): - y[table_name] = [] - for record in table_contents: - r = {"id": record["id"]} - norm_fields = { - key.lower().replace(" ", "_"): value - for key, value in record["fields"].items() - } - pp_data = cls.postprocess(table_name, norm_fields) - if pp_data is None: - _log.warning("Skip empty record") - else: - r.update(pp_data) - y[table_name].append(r) - report[table_name] = {"records": len(y[table_name])} + def dump(self, path: Path): + """Dump to YAML file.""" with path.open("w") as f: - yaml.dump(y, stream=f) - return report - - @classmethod - def postprocess(cls, table_name: str, fields: dict[str, Any]): - if table_name == "projects": - fields["active"] = bool(fields["development"].lower() == "active") - elif table_name == "products": - # move 'code' fields into a nested dict - fields["code"] = {} - for code_field in ("github", "pypi", "conda-forge"): - if code_field in fields: - fields["code"][code_field] = fields[code_field] - del fields[code_field] - elif table_name == "models": - # fill in blank values for certain required fields - for req_field in ( - "description", - "flowsheet_module", - "unit_models", - "property_package", - "reaction_package", - ): - if req_field not in fields: - fields[req_field] = "" - # break long descriptions into 2 fields - desc = fields["description"] - if len(desc) > 85: - fields["description"] = desc[:80] + "..." - fields["full_description"] = desc - if "configurations" in fields: - fields["configurations"] = ", ".join( - fields["configurations"].split("\n") - ) - # put sub-packages and links for unit models, etc. - # into '_data' dict for easy processing later - gh = "https://github.com/" - repo_roots = { - "watertap": f"{gh}watertap-org/watertap/tree/main", - "prommis": f"{gh}prommis/prommis/tree/main/src", - "idaes": f"{gh}idaes/idaes-pse/tree/main", - } - for k in ( - "unit_model", - "reaction_package", - "control_volume", - "property_package", - ): - names, repos = f"{k}s", f"{k}_repositories" - if names not in fields: - continue - if not fields[names].strip(): - continue # empty - if repos not in fields: + yaml.dump(self._tables, stream=f) + + def _post_projects(self, table_name: str, fields: dict[str, Any]): + fields["active"] = bool(fields["development"].lower() == "active") + + def _post_products(self, table_name: str, fields: dict[str, Any]): + # move 'code' fields into a nested dict + fields["code"] = {} + for code_field in ("github", "pypi", "conda-forge"): + if code_field in fields: + fields["code"][code_field] = fields[code_field] + del fields[code_field] + + def _post_models(self, table_name: str, fields: dict[str, Any]): + cur_name = fields["name"] + # fill in blank values for certain required fields + for req_field in ( + "description", + "flowsheet_module", + "unit_models", + "property_package", + "reaction_package", + ): + if req_field not in fields: + fields[req_field] = "" + # break long descriptions into 2 fields + desc = fields["description"] + if len(desc) > 85: + fields["description"] = desc[:80] + "..." + fields["full_description"] = desc + if "configurations" in fields: + fields["configurations"] = ", ".join(fields["configurations"].split("\n")) + # put sub-packages and links for unit models, etc. + # into '_data' dict for easy processing later + gh = "https://github.com/" + repo_roots = { + "watertap": f"{gh}watertap-org/watertap/tree/main", + "prommis": f"{gh}prommis/prommis/tree/main/src", + "idaes": f"{gh}idaes/idaes-pse/tree/main", + } + for k in ( + "unit_model", + "reaction_package", + "control_volume", + "property_package", + ): + names, repos = f"{k}s", f"{k}_repositories" + if names not in fields: + continue + if not fields[names].strip(): + continue # empty + if repos not in fields: + raise KeyError(f"Found {names} but missing {repos} in {fields}") + name_list = self._split_list(fields[names]) + repo_list = self._split_list(fields[repos]) + url_list = [] + for r in repo_list: + proj = r.split("/")[0] + try: + url_list.append(repo_roots[proj] + "/" + r) + except KeyError: raise KeyError( - f"Found {names} but missing {repos} in {fields['name']}" + f"Models: Bad project name '{proj}' for '{fields}' in {cur_name}::{k}" ) - name_list = [s.strip() for s in fields[names].split(";")] - repo_list = [s.strip() for s in fields[repos].split(";")] - url_list = [] - for r in repo_list: - proj = r.split("/")[0] - try: - url_list.append(repo_roots[proj] + "/" + r) - except KeyError: - raise KeyError( - f"Bad project name '{proj}' for '{fields['name']}' in {k}" - ) - if len(url_list) != len(name_list): - if len(url_list) == 1 and len(name_list) > 1: - # if one url, use for all - url_list = url_list + [url_list[0]] * (len(name_list) - 1) - else: - raise ValueError( - f"Name/repo list mismatch for {k} in {fields['name']}: {len(name_list)} names != {len(url_list)} urls" - ) - # create dict combining the information - fields[f"{k}_data"] = { - name: url_list[i] for i, name in enumerate(name_list) - } - elif table_name == "ui_products": - # check if empty - if "name" not in fields: - return None - # fill in blank values for certain required fields - for req_field in ( - "description", - "features", - ): - if req_field not in fields: - fields[req_field] = "" - # delete dumb fields - del fields["attachment_summary"] - # make list out of features - fields["features"] = [ - s.strip().replace("\n", " ") for s in fields["features"].split(";") - ] - # add screenshot info - fields["screenshots"] = cls.ui_screenshots(fields["name"]) - # build combined 'links' dict - fields["links"] = { - "gh": fields.get("repository", ""), - "docs": fields.get("documentation", ""), - # add name of this product if there are screenshots - "screenshots": fields["name"] if fields["screenshots"] else "", + if len(url_list) != len(name_list): + if len(url_list) == 1 and len(name_list) > 1: + # if one url, use for all + url_list = url_list + [url_list[0]] * (len(name_list) - 1) + elif self._soldier_on: + shorter = min(len(url_list), len(name_list)) + url_list = url_list[:shorter] + name_list = name_list[:shorter] + else: + raise ValueError( + f"Name/repo list mismatch for {cur_name}::{k}: {len(name_list)} names != {len(url_list)} urls.\nNAMES:\n{name_list}\nURLS:\n{url_list}" + ) + # create dict combining the information + fields[f"{k}_data"] = { + name: url_list[i] for i, name in enumerate(name_list) } - return fields - @classmethod - def ui_screenshots(cls, name: str) -> dict: + def _post_ui_products(self, table_name: str, fields: dict[str, Any]): + # check if empty + if "name" not in fields: + return None + # fill in blank values for certain required fields + for req_field in ( + "description", + "features", + ): + if req_field not in fields: + fields[req_field] = "" + # delete dumb fields + del fields["attachment_summary"] + # make list out of features + fields["features"] = [ + s.strip().replace("\n", " ") for s in fields["features"].split(";") + ] + # add screenshot info + fields["screenshots"] = self.ui_screenshots(fields["name"]) + # build combined 'links' dict + fields["links"] = { + "gh": fields.get("repository", ""), + "docs": fields.get("documentation", ""), + # add name of this product if there are screenshots + "screenshots": fields["name"] if fields["screenshots"] else "", + } + + def ui_screenshots(self, name: str) -> dict: """Get screenshot info from local file.""" # load once - if cls.screenshots is None: - with open(cls.sshot_path) as f: + if self.screenshots is None: + with open(self.sshot_path) as f: data = yaml.safe_load(f) # make UI names lowercase for easier matching - cls.screenshots = {k.lower(): v for k, v in data.items()} + self.screenshots = {k.lower(): v for k, v in data.items()} # look for data matching UI product name try: - sshot = cls.screenshots[name.lower()] + sshot = self.screenshots[name.lower()] except KeyError: _log.warning( - f"No screenshots found for UI product '{name}' in file '{cls.sshot_path}'" + f"No screenshots found for UI product '{name}' in file '{self.sshot_path}'" ) sshot = {} return sshot - def _split_fields(f, key): - return - - -def get_token(t): - if t: - return t - - try: - return os.environ[TOKENV] - except KeyError: - raise KeyError( - f"Please provide the token via the -t/--token option " - f"or by setting the environment variable {TOKENV}" - ) + @staticmethod + def _split_list(s): + items = [] + # split and clean up + for x in re.split(r";|,", s): + items.append(x.strip().replace("\n", " ").replace(" ", " ")) + return items def main(): p = argparse.ArgumentParser() - p.add_argument("output_file", metavar="PATH", help="YAML output file") + p.add_argument("output_file", metavar="OUTPUT_FILE", help="YAML output file") p.add_argument( - "--cache", - metavar="FILE", - help="Use cached JSON data in FILE. " - "If the file does not exist it will be created.", - default=None, + "-E", + "--ignore-errors", + action="store_true", + help="Ignore errors in input, continue anyways (!!)", ) - p.add_argument("-t", "--token", help=f"API token, otherwise look in {TOKENV}") p.add_argument( "-v", "--verbose", action="count", default=0, help="Increase log verbosity" ) @@ -246,28 +234,9 @@ def main(): ) return 1 - if args.cache: - p = Path(args.cache) - # if existing file, load it - if p.exists(): - _log.info(f"Loading data from cache file '{p}'") - with p.open() as f: - tables = json.load(f) - # otherwise query airtable and create for next time - else: - _log.info(f"Fetching data from airtable (cache)") - tables = IdaesplusAirtable(get_token(args.token)).get_tables() - _log.info(f"Writing airtable data to cache file '{p}'") - with p.open("w") as f: - json.dump(tables, f) - else: - _log.info("Fetching data from airtable") - tables = IdaesplusAirtable(get_token(args.token)).get_tables() - - _log.info(f"Writing YAML file {output_path}") - report = IdaesplusAirtable.dump_tables(output_path, tables) - - for table_name, data in report.items(): + tables = IdaesplusTables(continue_on_error=args.ignore_errors) + tables.dump(output_path) + for table_name, data in tables.report.items(): print(f"Wrote {data['records']} records for table {table_name}") return 0 From cb3240a8265ddb5a50a911656362c15e7ea0bc39 Mon Sep 17 00:00:00 2001 From: Dan Gunter Date: Fri, 6 Mar 2026 09:29:33 -0800 Subject: [PATCH 3/8] modelcompatibility field in ui products --- data.yaml | 20 ++++++++++++++------ update_data.py | 4 ++++ 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/data.yaml b/data.yaml index be0edb9..c3ea001 100644 --- a/data.yaml +++ b/data.yaml @@ -6176,7 +6176,8 @@ ui_products: docs: https://prommis.github.io/idaes-flowsheet-processor-ui/ gh: https://github.com/prommis/idaes-flowsheet-processor-ui screenshots: Flowsheet Processor - modelcompatibility: IDAES + modelcompatibility: + - IDAES name: Flowsheet Processor repository: https://github.com/prommis/idaes-flowsheet-processor-ui screenshots: @@ -6206,7 +6207,8 @@ ui_products: docs: https://idaes-ui.readthedocs.io/en/latest/user/fv/ gh: https://github.com/IDAES/idaes-ui screenshots: Flowsheet Visualizer - modelcompatibility: IDAES + modelcompatibility: + - IDAES name: Flowsheet Visualizer repository: https://github.com/IDAES/idaes-ui screenshots: @@ -6237,7 +6239,9 @@ ui_products: docs: https://prommis.github.io/idaes-connectivity/ gh: https://github.com/prommis/idaes-connectivity screenshots: Flowsheet Connectivity - modelcompatibility: Pyomo,IDAES + modelcompatibility: + - Pyomo + - IDAES name: Flowsheet Connectivity repository: https://github.com/prommis/idaes-connectivity screenshots: @@ -6261,7 +6265,8 @@ ui_products: docs: '' gh: https://github.com/prommis/prommis-ui screenshots: Superstructure UI - modelcompatibility: Custom + modelcompatibility: + - Custom name: Superstructure UI repository: https://github.com/prommis/prommis-ui screenshots: @@ -6292,7 +6297,8 @@ ui_products: docs: '' gh: https://www.project-pareto.org screenshots: PARETO UI - modelcompatibility: Custom + modelcompatibility: + - Custom name: PARETO UI repository: https://www.project-pareto.org screenshots: @@ -6319,7 +6325,9 @@ ui_products: docs: https://foqus.readthedocs.io/ gh: https://github.com/CCSI-Toolset/FOQUS screenshots: '' - modelcompatibility: Custom,Pyomo + modelcompatibility: + - Custom + - Pyomo name: FOQUS repository: https://github.com/CCSI-Toolset/FOQUS screenshots: {} diff --git a/update_data.py b/update_data.py index 9287f33..5a101e7 100644 --- a/update_data.py +++ b/update_data.py @@ -168,6 +168,10 @@ def _post_ui_products(self, table_name: str, fields: dict[str, Any]): fields["features"] = [ s.strip().replace("\n", " ") for s in fields["features"].split(";") ] + # make list out of model compatibility + fields["modelcompatibility"] = [ + x.strip() for x in fields["modelcompatibility"].split(",") + ] # add screenshot info fields["screenshots"] = self.ui_screenshots(fields["name"]) # build combined 'links' dict From 44396a3da3a090915b2b53248bd4c6bbbcbe43e4 Mon Sep 17 00:00:00 2001 From: Dan Gunter Date: Fri, 6 Mar 2026 10:46:51 -0800 Subject: [PATCH 4/8] removed projects since this is being replaced by text --- data.yaml | 60 ----------------------------------------------- data/projects.csv | 8 ------- update_data.py | 2 +- 3 files changed, 1 insertion(+), 69 deletions(-) delete mode 100644 data/projects.csv diff --git a/data.yaml b/data.yaml index c3ea001..4431989 100644 --- a/data.yaml +++ b/data.yaml @@ -6101,66 +6101,6 @@ products: links: '' name: PrOMMiS Flowsheet UI projects: PrOMMiS,PARETO -projects: -- active: true - description: Carbon Capture Simulation for Industry Impact - development: Active - homepage: https://netl.doe.gov/carbon-management/carbon-capture/ccsi2 - keywords: carbon capture,simulation,modeling,optimization,uncertainty quantification - name: CCSI2 - notes: '' - products: FOQUS -- active: true - description: Institute for the Design of Advanced Energy Systems - development: Active - homepage: https://idaes.org - keywords: equation oriented - name: IDAES - notes: '' - products: IDAES-PSE,Flowsheet Processor,Flowsheet Processor UI,IDAES Flowsheet UI -- active: true - description: Produced Water Initiative - development: Active - homepage: https://project-pareto.org - keywords: produced water,optimization - name: PARETO - notes: '' - products: PrOMMiS Flowsheet UI,WaterTAP Flowsheet UI,IDAES Flowsheet UI -- active: true - description: Process Optimization and Modeling for Minerals Sustainability - development: Active - homepage: https://netl.doe.gov/prommis - keywords: critical minerals,rare earth elements - name: PrOMMiS - notes: '' - products: Parameter Sweep,Flowsheet Processor,PrOMMiS,Flowsheet Processor UI,PrOMMiS - Flowsheet UI -- active: true - description: 'Python-based, open-source optimization modeling language ' - development: Active - homepage: https://www.pyomo.org/ - keywords: equation oriented,optimization - name: Pyomo - notes: '' - products: '' -- active: true - description: Water treatment Techno-economic Analysis Platform - development: Active - homepage: https://watertap.readthedocs.io - keywords: water treatment,water chemistry,techno-economic analysis - name: WaterTAP - notes: '' - products: WaterTAP,Parameter Sweep,WaterTAP-REFLO,Flowsheet Processor,Flowsheet - Processor UI,WaterTAP Flowsheet UI -- active: false - description: Design Integration and Synthesis Platform to Advance Tightly Coupled - Hybrid Energy Systems - development: Archived - homepage: https://dispatches.readthedocs.io - keywords: grid,hybrid energy systems - name: DISPATCHES - notes: '' - products: '' ui_products: - description: Run IDAES flowsheets with no coding and view graphical results. documentation: https://prommis.github.io/idaes-flowsheet-processor-ui/ diff --git a/data/projects.csv b/data/projects.csv deleted file mode 100644 index f90b155..0000000 --- a/data/projects.csv +++ /dev/null @@ -1,8 +0,0 @@ -Name,Description,Notes,Keywords,products,Homepage,Development -CCSI2,Carbon Capture Simulation for Industry Impact,,"carbon capture,simulation,modeling,optimization,uncertainty quantification",FOQUS,https://netl.doe.gov/carbon-management/carbon-capture/ccsi2,Active -IDAES,Institute for the Design of Advanced Energy Systems,,equation oriented,"IDAES-PSE,Flowsheet Processor,Flowsheet Processor UI,IDAES Flowsheet UI",https://idaes.org,Active -PARETO,Produced Water Initiative,,"produced water,optimization","PrOMMiS Flowsheet UI,WaterTAP Flowsheet UI,IDAES Flowsheet UI",https://project-pareto.org,Active -PrOMMiS,Process Optimization and Modeling for Minerals Sustainability,,"critical minerals,rare earth elements","Parameter Sweep,Flowsheet Processor,PrOMMiS,Flowsheet Processor UI,PrOMMiS Flowsheet UI",https://netl.doe.gov/prommis,Active -Pyomo,"Python-based, open-source optimization modeling language ",,"equation oriented,optimization",,https://www.pyomo.org/,Active -WaterTAP,Water treatment Techno-economic Analysis Platform,,"water treatment,water chemistry,techno-economic analysis","WaterTAP,Parameter Sweep,WaterTAP-REFLO,Flowsheet Processor,Flowsheet Processor UI,WaterTAP Flowsheet UI",https://watertap.readthedocs.io,Active -DISPATCHES,Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems,,"grid,hybrid energy systems",,https://dispatches.readthedocs.io,Archived \ No newline at end of file diff --git a/update_data.py b/update_data.py index 5a101e7..585c355 100644 --- a/update_data.py +++ b/update_data.py @@ -26,7 +26,7 @@ class IdaesplusTables: - table_names = ("projects", "products", "models", "ui_products") + table_names = ("products", "models", "ui_products") screenshots = None sshot_path = Path(__file__).parent / "screenshots.yaml" data_path = Path(__file__).parent / "data" From 1922562e7863262ccfad820c09caa1a109bfa6a8 Mon Sep 17 00:00:00 2001 From: Dan Gunter Date: Sat, 7 Mar 2026 08:01:25 -0800 Subject: [PATCH 5/8] yay --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index d4bb2cb..5f473ab 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= +SPHINXOPTS ?= -v SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = _build From 4761913e0a6823fc9379e966b2281992dd495c14 Mon Sep 17 00:00:00 2001 From: Anca Ostace Date: Thu, 19 Mar 2026 12:20:22 -0400 Subject: [PATCH 6/8] Update CCSI support email address --- contact.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contact.md b/contact.md index ef9fb02..7643f9c 100644 --- a/contact.md +++ b/contact.md @@ -23,7 +23,7 @@ simulation. - IDAES: - PrOMMiS: - WaterTAP: -- CCSI: ccsi-support@??? +- CCSI: - PARETO: ## Join Our Community From d696c05afc2d28c4e3602eb81f823bd326298349 Mon Sep 17 00:00:00 2001 From: Anca Ostace Date: Thu, 19 Mar 2026 12:36:58 -0400 Subject: [PATCH 7/8] Revise IDAES+ projects page Reorganized project documentation and added acknowledgements section. --- projects.md | 66 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 46 insertions(+), 20 deletions(-) diff --git a/projects.md b/projects.md index 396ee92..bf2c2f1 100644 --- a/projects.md +++ b/projects.md @@ -3,12 +3,9 @@ title: IDAES+ Projects --- # IDAES+ Projects -This is the unified documentation website for the IDAES+ projects, providing a -single entry point for the Institute for the Design of Advanced Energy Systems -(IDAES) and related projects. - -Click on one of the pages below to browse, or use the **search** function to -search the combined documentation for the IDAES+ projects. +IDAES+ brings together a suite of open-source projects, each contributing a +unique piece of the process modeling, simulation and advance optimization +ecosystem. ## IDAES Integrated Platform @@ -69,20 +66,6 @@ deployment of cost-effective carbon capture technologies. - Website: - GitHub: -## DISPATCHES (Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems) - -Developed to support the design, optimization, and analysis of tightly coupled -hybrid energy systems that integrate various energy generation, storage, and -conversion technologies, DISPATCHES is an open-source computational platform -that provides detailed dynamic models coupled with nonlinear model predictive -control to simulate system behavior under varying market conditions. - -- Website: -- GitHub: - [github.com/gmlc-dispatches/dispatches](https://github.com/gmlc-dispatches/dispatches) -- Documentation: - [dispatches.readthedocs.io](https://dispatches.readthedocs.io/) - ## PARETO (Produced Water Application for Beneficial Reuse, Environmental Impact, and Treatment Optimization) PARETO is an open-source, optimization-based decision-support tool designed to @@ -99,3 +82,46 @@ environmentally sustainable practices in produced water management. [github.com/project-pareto/project-pareto](https://github.com/project-pareto/project-pareto/) - Documentation with tutorials and examples: + +## Inactive project(s) + +## DISPATCHES (Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems) + +Developed to support the design, optimization, and analysis of tightly coupled +hybrid energy systems that integrate various energy generation, storage, and +conversion technologies, DISPATCHES is an open-source computational platform +that provides detailed dynamic models coupled with nonlinear model predictive +control to simulate system behavior under varying market conditions. + +- Website: +- GitHub: + [github.com/gmlc-dispatches/dispatches](https://github.com/gmlc-dispatches/dispatches) +- Documentation: + [dispatches.readthedocs.io](https://dispatches.readthedocs.io/) + +## Acknowledgements + +**IDAES**: We graciously acknowledge support for the Institute for the Design of Advanced Energy Systems +(IDAES) from the U.S. Department of Energy’s Hydrocarbons and Geothermal Energy Office through the +Simulation-based Engineering research program. + +**PROMMIS**: This effort was funded by the U.S. Department of Energy’s Process Optimization and Modeling +for Minerals Sustainability (PrOMMiS) Initiative, supported by the Department of Energy’s Hydrocarbons +and Geothermal Energy Office. + +**NAWI / WaterTap**: This material is based upon work supported by the National Alliance for Water Innovation +(NAWI), funded by the U.S. Department of Energy, Office of Critical Minerals and Energy Innovation (CMEI), +Industrial Technologies Office (ITO), under Funding Opportunity Announcement Number DE-FOA-0001905. + +**CCSI2**: We graciously acknowledge support for the Carbon Capture Simulation for Industry Impact (CCSI2) +project from the U.S. Department of Energy, Hydrocarbons and Geothermal Energy Office, through the +Point Source Carbon Capture Program. + +**PARETO**: We gratefully acknowledge support from the U.S. Department of Energy, Office of Hydrocarbons and +Geothermal Energy, through the Advanced Production Technologies Program. + +**DISPATCHES**: This work was conducted as part of the Design Integration and Synthesis Platform to Advance +Tightly Coupled Hybrid Energy Systems (DISPATCHES) project through the Grid Modernization Lab Consortium +with funding from the U.S. Department of Energy’s Office of Fossil Energy and Carbon Management, +Office of Nuclear Energy, and Hydrogen and Fuel Cell Technology Office. + From 463366cb74023e11dddc7e7eb0d8c7d3f67ebfaa Mon Sep 17 00:00:00 2001 From: Dan Gunter Date: Thu, 19 Mar 2026 15:09:17 -0700 Subject: [PATCH 8/8] removed airtable refs, added more output for -E mode in update_data --- README.md | 37 ++++++++++--------------------------- update_data.py | 18 +++++++++++------- 2 files changed, 21 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 0aa22c1..1b9900a 100644 --- a/README.md +++ b/README.md @@ -5,35 +5,18 @@ This repository has the source code for the IDAES+ documentation, which covers all projects that use the [IDAES](https://idaes.org) platform. -## Updating pages from Airtable +## Updating tabular input data -### Explanation +The data that builds tables of content for several pages is in CSV files under data/. +Filenames in that directory should correspond to Markdown files they belong to. +This data is post-processed into YAML that is then used by the documentation pages +to create content. -These pages have tables created from data in the IDAES+ project on Airtable. -[Airtable](https://airtable.com) is an online database that can be jointly -edited like a shared spreadsheet. +To update the CSV, just use your favorite spreadsheet program or +a text editor. Make sure to save as plain CSV again, and commit your +changes to the repository. -The current method of connecting this data to the documentation pages is to -fetch that data and format it as a YAML file. The downside to this procedure, as -opposed to fetching the data directly from within the documentation pages via -JavaScript, is an extra step to propagate changes from Airtable to the -documentation. The upside is that changes in the documentation are deployed -intentionally and not accidentally when the Airtable data is changed. This -should result in less surprises and more chances to check for errors. - -### How-to - -To update the file, run the `update_data.py` script and write the output to `data.yaml`. +When you're done, you need to update the YAML input files from the CSV, +run the `update_data.py` script and write the output to `data.yaml`. For example: `python update_data.py data.yaml` - -In order to connect to Airtable and retrieve the data, you will need to provide -the correct API key for IDAES+. This is a secret and not in this repository. -Once you have obtained this key either provide it directly on the command-line -or set it in the environment variable `IDAES_AIRTABLE_APIKEY`. - -You can cache the data retrieved from Airtable with the `--cache` option, e.g.: -`python update_data.py data.yaml --cache cache.json`. In this mode, no new data -is fetched, but the raw data is reformatted for the web pages. This is useful -when working on the script itself. Note also that if the cache file exists the -script does not attempt to connect to Airtable, so the API key is not needed. diff --git a/update_data.py b/update_data.py index 585c355..18dba3a 100644 --- a/update_data.py +++ b/update_data.py @@ -138,14 +138,18 @@ def _post_models(self, table_name: str, fields: dict[str, Any]): if len(url_list) == 1 and len(name_list) > 1: # if one url, use for all url_list = url_list + [url_list[0]] * (len(name_list) - 1) - elif self._soldier_on: - shorter = min(len(url_list), len(name_list)) - url_list = url_list[:shorter] - name_list = name_list[:shorter] else: - raise ValueError( - f"Name/repo list mismatch for {cur_name}::{k}: {len(name_list)} names != {len(url_list)} urls.\nNAMES:\n{name_list}\nURLS:\n{url_list}" + msg = ( + f"Name/repo list mismatch for {cur_name}::{k}: {len(name_list)} names != {len(url_list)} urls.\n" + f" names: {name_list}\n urls: {url_list}" ) + if self._soldier_on: + shorter = min(len(url_list), len(name_list)) + url_list = url_list[:shorter] + name_list = name_list[:shorter] + _log.warning(msg) + else: + raise ValueError(msg) # create dict combining the information fields[f"{k}_data"] = { name: url_list[i] for i, name in enumerate(name_list) @@ -216,7 +220,7 @@ def main(): "-E", "--ignore-errors", action="store_true", - help="Ignore errors in input, continue anyways (!!)", + help="Ignore errors in input, continue anyways (but log them)", ) p.add_argument( "-v", "--verbose", action="count", default=0, help="Increase log verbosity"