Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Recent Releases of WaterTAP

WaterTAP - 1.3 Release

1.3 Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.3.0 Release Highlights

This release includes several new features, updates, and improvements. Key additions include:

  • Support for VMD, PGMD, and CGMD
  • A new method in ED1d for calculating membrane resistance as a function of ion concentration
  • Revised UF_ZO costing defaults
  • Updated KLa values for BSM2-P

Additionally, this release includes several internal updates and improvements, including:

  • Updates to the documentation configuration
  • Improvements to the interval initializer to ensure bounds are always restored
  • Updates to the idaes-pse requirement to version 2.8.0
  • Creation of a CODEOWNERS file for improved repository management

These changes contribute to the overall stability and functionality of WaterTAP, and we recommend upgrading to version 1.3 for the latest features and improvements.

What's Changed

Full Changelog: https://github.com/watertap-org/watertap/compare/1.2.0...1.3.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 28 days ago

WaterTAP - 1.2 Release

1.2 Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.2.0 Release Highlights

This release includes numerous new features, updates, and improvements. Key additions and changes include:

New models and features:

  • BSM2-P Effluent Metrics without flowsheet constraints
  • MCAS with generic crystallizer
  • TVC model
  • RO0D can now be dynamic
  • Molar flows for precipitate and reagent to simplify Reaktoro integration

Updates to existing models:

  • BSM2-P CSTR model updated
  • Dye Desal Flowsheet parameters updated
  • Costing in Dye Desal Flowsheet updated
  • ASM1, ASM2d, and ADM1 property packages re-scaled
  • Modified ASM2d model with new scaling tool

Improvements to documentation and user interface:

  • Getting Started documentation updated
  • Looptool documentation updated
  • Fix for doc typo in flowsheet list

Internal updates and improvements:

  • IDAES requirement updated to 2.7.0
  • IDAES-PSE requirement updated to 2.7.0
  • Flexparser 0.4 excluded as workaround for IDAES issue
  • Migration of watertap.ui.fsapi to idaes_flowsheet_processor
  • Replacement of watertap.core.plugins with watertap_solvers
  • Repair of OLIAPI
  • Ensured no unhandled warnings are emitted during pytest run

Removal of deprecated code:

  • Simple ASM2d packages deleted

These changes contribute to the overall stability, functionality, and usability of WaterTAP, and we recommend upgrading to version 1.2 for the latest features and improvements.

Detailed Changes From 1.1 Release

New Contributors

Full Changelog: https://github.com/watertap-org/watertap/compare/1.1.0...1.2.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 4 months ago

WaterTAP - 1.1 Release

1.1 Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.1.0 Release Highlights

  • Fixed a bug for enthalpy units in crystallizer property package
  • Removed module type option for osmotically assisted reverse osmosis
  • Added an option to add volume to the membrane channel
  • Refined the ADM1/ASM2d interface
  • Updated BSM2 costing
  • Added modified ADM1 flowsheet
  • Added functionality to get LCOW and SEC for each unit
  • Added debugging solver wrapper and documentation
  • Added helper functions for 0D properties in the membrane channel

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 7 months ago

WaterTAP - 1.1 Release Candidate #1

1.1 Release Candidate #1

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.1.0rc1 Release Highlights

  • Fixed a bug for enthalpy units in crystallizer property package
  • Removed module type option for osmotically assisted reverse osmosis
  • Added an option to add volume to the membrane channel
  • Refined the ADM1/ASM2d interface
  • Updated BSM2 costing
  • Added modified ADM1 flowsheet
  • Added functionality to get LCOW and SEC for each unit
  • Added debugging solver wrapper and documentation
  • Added helper functions for 0D properties in the membrane channel

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 7 months ago

WaterTAP - 1.1 Release Candidate #0

1.1 Release Candidate #0

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.1.0rc0 Release Highlights

What's Changed

Full Changelog: https://github.com/watertap-org/watertap/compare/1.0.0...1.1.0rc0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 7 months ago

WaterTAP - 1.0 Release

1.0 Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.0.0 Release Highlights

What's Changed

Full Changelog: https://github.com/watertap-org/watertap/compare/0.12.0...1.0.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 9 months ago

WaterTAP - 1.0 Release Candidate #1

1.0 Release Candidate #1

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.0.0rc1 Release Highlights

What's Changed

Full Changelog: https://github.com/watertap-org/watertap/compare/0.12.0...1.0.0rc1

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 9 months ago

WaterTAP - 1.0 Release Candidate #0

1.0 Release Candidate #0

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 1.0.0rc0 Release Highlights

What's Changed

Full Changelog: https://github.com/watertap-org/watertap/compare/0.12.0...1.0.0rc0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl 10 months ago

WaterTAP - 0.12 Release

0.12 Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.12.0 Release Highlights

What's Changed

Full Changelog: https://github.com/watertap-org/watertap/compare/0.11.0...0.12.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl about 1 year ago

WaterTAP - 0.12 Release Candidate #0

0.12 Release Candidate #0

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.12.0rc0 Release Highlights

What's Changed

Full Changelog: https://github.com/watertap-org/watertap/compare/0.11.0...0.12.0rc0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl about 1 year ago

WaterTAP - 0.11.0 Release

0.11.0 Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.11.0 Release Highlights

  • General bug fixes, documentation updates, and code maintenance
  • Added more functionality in using the OLI cloud API with WaterTAP
  • Added a one dimensional osmotically-assisted reverse osmosis (OARO) unit model
  • Added an example flowsheet for the cost optimization of multistage OARO
  • Added an option to use Spiegler Kedem Katchalsky (SKK) in the RO unit model
  • Significantly revised and updated the electrocoagulation unit model
  • Refined the ion exchange unit model and updated the costing to the most recent release of EPA-WBS model
  • Modified the nanofiltration unit model to improve stability when ion concentrations are low
  • Improved stability of the electrodialysis example flowsheet
  • Refactored the WaterTAP and zero order costing packages to be more unified
  • Refined the MCAS property package to be more user friendly by providing additional warnings when used incorrectly and automatically loading molecular weight and charge data
  • Added how-to documentation for using the MCAS property package
  • Added Binder functionality to jupyter notebooks in WaterTAP and created relevant documentation
  • Added a modified ASM2d flowsheet, which includes the several completely stirred tank reactors in series, followed by a secondary clarifier, with phosphorus extension
  • Added effluent/influent quality metrics to ASM1 which include chemical oxygen demand, 5-day biological oxygen demand, total nitrogen, total Kjeldahl nitrogen, and total suspended solids
  • Added costing for BSM2 including: clarifiers, activated sludge reactors, anaerobic digestor, thickener, dewatering unit, and electricity
  • Addressed issues and added more sampling capabilities to the parameter sweep and loop tool
  • Added three new tutorials:
    • Conducting a parameter estimation
    • Incorporating custom relationships
    • Conducting OLI Cloud API calculations
  • Refined the BSM2 tutorial
  • Added two WaterTAP example flowsheets to the graphical user interface (GUI):
    • RO with energy recovery
    • Mechanical vapor compression
  • Refined the BSM2 GUI flowsheet

Full Changelog: https://github.com/watertap-org/watertap/compare/0.10.0...0.11.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 1 year ago

WaterTAP - 0.11 Release Candidate #3

0.11 Release Candidate #3

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.11.0rc3 Release Highlights

Full Changelog: https://github.com/watertap-org/watertap/compare/0.11.0rc1...0.11.0rc3

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 1 year ago

WaterTAP - 0.11 Release Candidate #1

0.11 Release Candidate #1

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.11.0rc1 Release Highlights

What's Changed

New Contributors

Full Changelog: https://github.com/watertap-org/watertap/compare/0.10.0...0.11.0rc1

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 1 year ago

WaterTAP - 2023 Sept Release

0.10 Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.10.0 Release Highlights

  • Added an initial membrane distillation model and documentation
  • Added an initial API for making OLI Cloud calculations (license required)
  • Refined the osmotically assisted reverse osmosis model and its multi-stage flowsheet example
  • Added mass-basis as a configuration option for the multi-component aqueous solution (MCAS) property package, previously it only supported mole-basis
  • Refined and reformulated the activated sludge and anaerobic digestor models that make up Benchmark Simulation Model 1 and 2 (BSM1 and BSM2), greatly improving stability
  • Added a demonstration of BSM2 in a jupyter notebook and the graphical user interface (GUI)
  • Added an analysis for treating water contaminated with dye with nanofiltration and reverse osmosis to the GUI
  • Updated GUI workflow to include parameter sweep capability (parameter sensitivity)

Full Changelog: https://github.com/watertap-org/watertap/compare/0.9.0...0.10.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 1 year ago

WaterTAP - 0.10 Release Candidate #0

0.10 Release Candidate #0

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.10.0rc0 Release Highlights

What's Changed

New Contributors

Full Changelog: https://github.com/watertap-org/watertap/compare/0.9.0...0.10.0rc0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 1 year ago

WaterTAP - 2023 Jun Release

2023 Jun Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.9.0 Release Highlights

  • General bug fixes and code maintenance
  • Added a NaCl property model with temperature dependence (useful for evaporative processes)
  • Refined the mechanical vapor compression flowsheet example
  • Added rectifier costing method for electrochemical processes
  • Added an electrolyzer model
  • Refined electrodialysis costing
  • Added a modified Activated Sludge Model No. 2d (ASM2d)
  • Updated Anaerobic Digestion Model No. 1 (ADM1) and ASM2d translator block
  • Added auxiliary unit models for Benchmark Simulation Model No. 2 (BSM2) including a dewaterer, thickener, and primary clarifier
  • Added Jupyter notebook tutorial on nanofiltration with Donnan Steric Pore Model with Dielectric Exclusion (DSPM-DE)

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl almost 2 years ago

WaterTAP - 2023 Mar Release

2023 Mar Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.8.0 Release Highlights

  • General maintenance and bug fixes
  • Updated WaterTAP to be compatible with IDAES v2.0.0
  • Updated and refactored property models to include pressure effects in enthalpy and have consistent indexing of variables and constraints
  • Improved the parameter sweep tool to provide additional functionality
  • Reorganized model diagnostic tools
  • Added a new option for membrane processes - a spiral wound friction factor calculation
  • Added more properties to the multicomponent aqueous solution property package - diffusivities and Laliberte correlation for densities
  • Added costing for osmotically assisted reverse osmosis (OARO)
  • Added a simple electrocoagulation model
  • Added an example demonstration of electrodialysis desalination system with recirculation and water recovery control
  • Added an example demonstration of ion exchange for calcium removal
  • Added the Anaerobic Digestor Model no. 1 (ADM1), including temperature dependent expressions and a phosphorous extension
  • Added translator blocks for Activated Sludge Model no. 1 (ASM1) to ADM1 and vice versa
  • Added a selective oil permeation model
  • Refined granular activated carbon model - improving its stability and including more details on auxiliary energy consumption and costing
  • Added and refined documentation for the following: zero order models, ion exchange, mechanical vapor compression, water property package, ADM1, ASM1 and ADM1 translator blocks

Full Changelog: https://github.com/watertap-org/watertap/compare/0.7.0...0.8.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl about 2 years ago

WaterTAP - 2022 Dec Release

2022 Dec Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.7.0 Release Highlights

What's Changed

  • Updated getting started section and tutorials to better support users
  • Added an osmotically assisted reverse osmosis (OARO) model and an example demonstrating an OARO-RO system
  • Refined the nanofiltration model (Donnan Steric Pore Model with Dielectric Exclusion) - updated scaling and improved model stability and solving performance
  • Refined the ion exchange model - improved the initialization of the model and addressed a bug in its test
  • Refined the electrodialysis model - added pressure drop and limiting current density calculations
  • Refined the granular activated carbon (GAC) model for clarity and improving performance
  • Renamed and modified the property package used for the nanofiltration Donnan Steric Pore Model to multi-component aqueous solution - this change reflects how it is used for more than the nanofiltration model
  • Refactored and updated the WaterTAP costing package - standardized terms, separated parameters based on unit models, added utility methods and helpers, updated the costing of material and energy flows
  • Added isothermal configuration arguments to relevant unit models
  • Standardized and streamlined property package constraint indexing and scaling
  • Addressed issues with documentation and tutorial testing

Full Changelog: https://github.com/watertap-org/watertap/compare/0.6.0...0.7.0

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 2 years ago

WaterTAP - 2022 Sep Release

2022 Sep Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.6.0 Release Highlights

  • Implemented an initial graphical user interface (GUI) - application is deployed as a simple one-click install on Windows, MacOS, and Linux and includes functionality for: visualizing prebuilt flowsheets; adjusting their inputs; and saving, loading, and comparing solutions
  • Created and connected flowsheets to the GUI representing the water resource recovery systems under DE-FOA0002336 portfolio
  • Updated documentation for model refinements and added pages for the zero order unit models
  • Updated and fixed bugs in some zero order unit models
  • Added an introductory tutorial
  • Added a pump model with part-load-performance and an efficiency-flow correlation
  • Added an ion exchange model with costing (Cation and anion exchange demonstrations)
  • Refactored membrane models to use a new base component called a membrane channel
  • Refined nanofiltration DSPM-DE model and tests
  • Refined the simple electrolyte property model (DSPM-DE)
  • Refined and added costing for mechanical vapor compression (MVC) model
  • Refined and added costing for granular activated carbon (GAC) model
  • Refined and added costing for ultraviolet (UV) and UV advanced oxidation process models
  • Refined electrodialysis model and added a flowsheet demonstration
  • Refined ASM1 and ASM2d models and added full wastewater treatment train demonstrations for each
  • Improved the WaterTAP costing package
  • Enhanced the parameter sweep tool
  • Updated WaterTAP to address deprecations from IDAES

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 2 years ago

WaterTAP - 2022 Jun Release

2022 Jun Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.5.0 Release Highlights

  • Fixed bugs and implemented maintenance improvements
  • Standardized and renamed property variables across property packages
  • Enhanced the costing packages
  • Modified the coagulation-flocculation model and added documentation
  • Added an energy recovery device based on a pelton turbine
  • Added an initial 0D and 1D electrodialysis model (NaCl solution demonstration)
  • Added a simple boron removal unit operation based on pH swing with documentation
  • Added an example for the electrolyte database (EDB) using the Mongo cloud database
  • Added costing and documentation for the crystallizer model (NaCl solution demonstration)
  • Added an initial granular activated carbon model (1,2-Dichloroethane and Trichloroethylene demonstration)
  • Added an initial ultraviolet advanced oxidation process model (NDMA demonstration)
  • Added simple models of core wastewater treatment technologies under DE-FOA0002336 portfolio
  • Added initial ASM1 and ASM2d models for representing activated sludge processes
  • Refined low salt rejection cost optimization example
  • Refined the nanofiltration model based on Donnan Steric Pore Model with Dielectric Exclusion by fixing a bug in the model and verifying the model performs as expected
  • Fixed some errors in simple models merged in from WaterTAP3

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl almost 3 years ago

WaterTAP - 2022 Mar Release

2022 Mar Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.4.0 Release Highlights

  • Updated costing to new IDAES infrastructure with significant improvements to its flexibility and usability
  • Added infrastructure for supporting simple zero order models of multiple types and connecting them with a database
  • Merged in data and models from NAWI's WaterTAP3 tool (https://github.com/NREL/WaterTAP3) - including ~70 zero order models with costing across a broad range of water treatment technologies
  • Added several zero order models for wastewater resource recovery
  • Added coagulation-flocculation model based on user input jar test data
  • Added an initial mechanical vapor compression model (seawater desalination demonstration)
  • Added an initial crystallization model (NaCl solution demonstration)
  • Added an initial nanofiltration model based on Donnan Steric Pore Model with Dielectric Exclusion (pending validation for a use case)
  • Added property packages that span liquid, vapor, and solid phases (required for mechanical vapor compression and crystallization models)
  • Improved electrolyte database through bug fixes, clean up, and additional tests for maintenance
  • Refined the parameter sweep tool
  • Improved the "ipopt-watertap" default solver through additional options, robustness updates, and bug fixes
  • Added developer tools for infeasibility diagnostics

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl about 3 years ago

WaterTAP - 2021 Dec Patch Release

2021 Dec Patch Release

Start with our online documentation to get started with install instructions, examples, etc.

WaterTAP 0.3.1 Release Highlights

  • Updated model initialization after a bug affecting WaterTAP was fixed in IDAES 1.12.1 (#287, #289)

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 3 years ago

WaterTAP - 2021 Dec Release

2021 Dec Release

WaterTAP is an open-source water treatment model library that is compatible with the IDAES Platform (https://idaes.org), an advanced process systems engineering tool developed by the U.S. Department of Energy.

Documentation is located at https://watertap.readthedocs.org/en/0.3.0.

0.3.0 Release Highlights:

  • Updated the name from ProteusLib to WaterTAP
  • Reorganized repository to prepare the merger of WaterTAP3 model and data
  • Added zero-order base class models that will form the basis of most WaterTAP3 models
  • Updated all chemistry tests to use new IDAES log formulations
  • Updated the electrolyte database (EDB) EDB by removing out of date information, leveraging MongoDB, and allowing users to control the output and customize the reaction order
  • Added tests demonstrating the precipitation in equilibrium processes including remineralization, water softening, phosphorous removal
  • Added more documentation on the EDB
  • Updated zero-order nanofiltration model to be compatible with the IDAES generic property package
  • Added utilities to automatically use improved scaling methods (gradient based jacobian scaling)
  • Partially refactored membrane models to centralize function that write common constraints

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 3 years ago

WaterTAP - 2021 Sep Release

2021 Sep Release

ProteusLib is an open-source water treatment model library funded by the National Alliance for Water Innovation (https://www.nawihub.org) that is compatible with the IDAES Platform (https://idaes.org), an advanced process systems engineering tool developed by the U.S. Department of Energy.

Documentation is located at https://proteuslib.readthedocs.org/en/0.2.0.

0.2.0 Release Highlights:

  • Reverse osmosis, pressure exchanger, and nanofiltration unit models and seawater and NaCl solution property models
  • Other relevant models for water treatment systems are located in the IDAES repository, including:
    • Separator, mixer, pump, and reactor unit models
    • Electrolyte nonrandom two liquid (eNRTL) property model, and IDAES generic property and reaction models
  • Example flowsheets that use ProteusLib and IDAES models to demonstrate the cost optimization of water treatment trains including:
    • Seawater RO desalination with energy recovery
    • Low salt rejection reverse osmosis
    • High pressure reverse osmosis with pretreatment and gypsum scaling prediction
  • Multiple tests demonstrating the simulation of detailed equilibrium based electrolyte chemical processes including chlorination, phosphorous removal, re-carbonation, remineralization, and softening. These processes are modeled using IDAES generic property and reaction packages.
  • Examples of using the electrolyte nonrandom two liquid (eNRTL) activity coefficient model for determining the pH and the saturation index of gypsum
  • Tools that support parametric and stochastic sensitivity analyses

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 3 years ago

WaterTAP - 2021 Sep Release Candidate # 0

2021 Sep Release Candidate # 0

Start with our online documentation to get started with install instructions, examples, etc.

0.2.0rc0 Release Highlights:

  • First September release for ProteusLib

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl over 3 years ago

WaterTAP - 2021 June (internal) Release

ProteusLib 0.1.0 June 2021 Internal Release

Start with our online documentation to get started with install instructions, tutorials, etc.

Release Highlights

  • Documentation for initial release ready for final review and testing

Natural Resources - Water Supply and Quality - Python
Published by lbianchi-lbl almost 4 years ago