1.5 Release

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

WaterTAP 1.5.0 Release Highlights

Release Notes

New Features

• ASM3 Model Development - Added new ASM3 model implementation by @luohezhiming in #1593
• RO Initialization Enhancement - Added option to relax degrees of freedom during initialization in RO by @avdudchenko in #1645
• LSRRO Tutorial - New tutorial for LSRRO by @adam-a-a in #1629

Enhancements

• Seawater Property Models - Updated for consistency by @adam-a-a in #1687
• Interval Initializer - Added fail flag argument by @adam-a-a in #1609
• GUI Improvements
  • Enhanced output descriptions by @MarcusHolly in #1710
  • Added clarity to RO with ERD GUI descriptions by @MarcusHolly in #1703
  • BSM2 GUI fix by @MarcusHolly in #1634

Documentation

Tutorial Updates

• Introduction tutorial by @MarcusHolly in #1639
• RO tutorial by @MarcusHolly in #1643
• BSM2 Jupyter notebook by @MarcusHolly in #1628
• Model customization tutorial typo correction by @MarcusHolly in #1678
• Embedded YouTube video in NF tutorial by @MarcusHolly in #1667

Technical Documentation

• NaCl property pack documentation by @MarcusHolly in #1677
• RO config args autodocs by @MarcusHolly in #1688
• Effluent metrics added to AS documentation by @MarcusHolly in #1621
• RO and pump costing docs by @MarcusHolly in #1702
• ERD documentation typo fix by @MarcusHolly in #1690
• WaterTAP acronym added to docs by @MarcusHolly in #1683

Other Documentation Fixes

• Fixed broken readthedocs link by @sufikaur in #1709
• Black formatting on how-to code blocks and other small fixes by @kurbansitterley in #1674

Bug Fixes

• Modified ASM2d - Corrected error in reaction model by @MarcusHolly in #1608
• BSM2 - Removed kla by @adam-a-a in #1603
• LSRRO - Fixed circular import by @adam-a-a in #1700
• LSRRO - Fixed image by @adam-a-a in #1647
• General fix by @bknueven in #1627

Code Quality & Maintenance

• Formatting - Ran Black on tutorials by @kurbansitterley in #1673
• Scaling - Aligned WaterTap with IDAES scaling changes by @dallan-keylogic in #1695
• Windows Compatibility - Temporary fix for failing Windows checks by @adam-a-a in #1637

Dependencies & Configuration

• IDAES Update - Updated idaes-pse requirement to 2.9.0 by @sufikaur in #1669
• Pylint Update - Updated to v3.3.9 to match Pyomo by @sufikaur in #1684
• Sphinx Configuration - Uses version from installed package to set documentation version info by @sufikaur in #1626

Administrative

Code Ownership Updates

• Off-boarded lbianchi-lbl by @sufikaur in #1642
• Off-boarded team members no longer on the project by @sufikaur in #1649

Copyright Updates

• Updated header for Jupyter notebooks by @ksbeattie in #1708
• Updated copyright header for 2026 by @ksbeattie in #1707
• Changed NREL name in copyright header by @ksbeattie in #1711

Collaborators

• Added SLAC/Stanford to collaborating institutions by @avdudchenko in #1650

New Contributors

• @sufikaur made their first contribution in #1642
• @dallan-keylogic made their first contribution in #1695

Full Changelog: 1.4.0...1.5.0

1.5 Release Candidate #0

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

WaterTAP 1.5.0rc0 Release Highlights

What's Changed

• fail flag arg for interval_initializer by @adam-a-a in #1609
• Remove kla from bsm2 by @adam-a-a in #1603
• Development of ASM3 Model by @luohezhiming in #1593
• Correct Error in Modified ASM2d Rxn Model by @MarcusHolly in #1608
• Fix 1624 by @bknueven in #1627
• BSM2 GUI Fix by @MarcusHolly in #1634
• temp fix for failing windows checks by @adam-a-a in #1637
• Off boarding lbianchi-lbl from code ownership by @sufikaur in #1642
• Update BSM2 Jupyter Notebook by @MarcusHolly in #1628
• Update RO Tutorial by @MarcusHolly in #1643
• LSRRO tutorial by @adam-a-a in #1629
• fix lsrro image by @adam-a-a in #1647
• Off boarding team members from code ownership who are no longer on the project by @sufikaur in #1649
• Use version from installed package to set Sphinx documentation version info by @sufikaur in #1626
• Add SLAC/Stanford to Collaborating Institutions by @avdudchenko in #1650
• Adds option to relax DOFs during initlization in RO by @avdudchenko in #1645
• Update idaes-pse requirement for 2.9.0 by @sufikaur in #1669
• Update Introduction Tutorial by @MarcusHolly in #1639
• Update NaCl Prop Pack Documentation by @MarcusHolly in #1677
• Embed YouTube Video to NF Tutorial by @MarcusHolly in #1667
• Correct Typo in Model Customization Tutorial by @MarcusHolly in #1678
• Run Black on Tutorials by @kurbansitterley in #1673
• Add WaterTAP Acronym into Docs by @MarcusHolly in #1683
• Black on how-to code blocks in docs; other small doc fixes by @kurbansitterley in #1674
• Update seawater property models for consistency by @adam-a-a in #1687
• Add Autodocs for RO Config Args by @MarcusHolly in #1688
• Add Effluent Metrics to AS Documentation by @MarcusHolly in #1621
• Fix Typo in ERD Documentation by @MarcusHolly in #1690
• Add Clarity to RO w/ERD GUI Descriptions by @MarcusHolly in #1703
• Update RO and Pump Costing Docs by @MarcusHolly in #1702
• Fix broken link in readthedocs by @sufikaur in #1709
• Updating header for jupyter notebooks by @ksbeattie in #1708
• Updating copyright header for 2026 by @ksbeattie in #1707
• Update pylint version to match pyomo (v 3.3.9) by @sufikaur in #1684
• Bring WaterTap in line with changes in IDAES scaling by @dallan-keylogic in #1695
• fix lsrro circular import by @adam-a-a in #1700
• Changing name of NREL in copyright header by @ksbeattie in #1711
• Enhance GUI Output Descriptions by @MarcusHolly in #1710

New Contributors

• @sufikaur made their first contribution in #1642
• @dallan-keylogic made their first contribution in #1695

Full Changelog: 1.4.0...1.5.0rc0

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

WaterTAP 1.4.0 Release Highlights

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

New Models and Features

• Electrodialysis - Bipolar - 1D
• Simple 0D Nanofiltration model

Model Updates and Re-Scaling

• Anaerobic Digester re-scaled
• CSTR re-scaled
• Clarifier re-scaled
• Thickener and Dewaterer re-scaled
• BSM2 Translator Block re-scaled
• Conventional BSM2 and BSM2-P models updated with scalers
• Modified ASM2d model with in-line references

Documentation and User Interface Improvements

• Update WaterTAP citation
• Add flowsheet link to documentation
• Replace full URLs with internal hyperlinks
• Fix broken link to parmest tutorial
• Minor costing documentation fixes
• ZO flowsheet pointer added

Internal Updates and Improvements

• Update runner images in GitHub Actions workflows
• Remove Intel macOS CI job
• Correct COD and BOD equations
• Change electricity_cost units to base_currency

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

1.4 Release Candidate #0

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

WaterTAP 1.4.0rc0 Release Highlights

What's Changed

• Replace Full URLs with Internal Hyperlinks by @MarcusHolly in #1568
• Update WaterTAP Citation by @ksbeattie in #1561
• Add Flowsheet Link to Documentation by @MarcusHolly in #1567
• Update runner images in GitHub Actions workflows by @lbianchi-lbl in #1569
• Add In-Line References to Modified ASM2d by @MarcusHolly in #1570
• Electrodialysis- Bipolar - 1D by @johnson12742 in #1554
• Documentation import path by @zacharybinger in #1574
• Fix broken link to parmest tutorial by @adam-a-a in #1580
• Correct COD and BOD equations by @OOAmusat in #1576
• ZO Flowsheet Pointer by @MarcusHolly in #1578
• Remove Intel macOS CI job by @lbianchi-lbl in #1583
• Minor Costing Documentation Fixes by @kurbansitterley in #1586
• Anaerobic Digester Re-Scaling by @MarcusHolly in #1535
• Dye Desal Base Currency by @MarcusHolly in #1588
• Change electricity_cost units to be base_currency by @kurbansitterley in #1589
• CSTR Re-Scaling by @MarcusHolly in #1542
• Clarifier Re-Scaling by @MarcusHolly in #1543
• Thickener & Dewaterer Re-Scaling by @MarcusHolly in #1545
• BSM2 Translator Block Re-Scaling by @MarcusHolly in #1546
• Reformulate Expr_Ifs in ASM2d-ADM1 Translators by @MarcusHolly in #1563
• Simple OD Nanofiltration model by @andrewlee94 in #1536
• Apply Scalers to Conventional BSM2 by @MarcusHolly in #1585
• Apply Scalers to BSM2-P by @MarcusHolly in #1596

Full Changelog: 1.3.0...1.4.0rc0

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.

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.

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

1.0 Release

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

WaterTAP 1.0.0 Release Highlights

• Reorganized the repository, notably the examples and property_model subdirectories
• Added significantly more documentation, notably flowsheet examples and costing
• Updated tutorial landing page and revised/added tutorials
• Added a WaterTAP get_solver method so users can explicitly choose the solver with WaterTAP settings
• Added the flowsheet examples to the graphical user interface
• Addressed bugs in the WaterTAP-OLI functionality and unit model reports
• Modified the MCAS property model to be compatible with the zero order models
• Added spiral wound option to reverse osmosis models
• Added steam heater, and condenser models with options to calculate cooling water requirement and steam extraction rate
• Added an interval-based initialization capability
• Moved parameter sweep to its own repository (anticipated to be moved to IDAES)
• Removed obsolete wastewater resource recovery flowsheets and obsolete WaterTAP3 data files
• Archived the electrolyte database (EDB)

0.12 Release

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

WaterTAP 0.12.0 Release Highlights

• General bug fixes, documentation updates, and code maintenance
• Added 1D membrane distillation model
• Added an example flowsheet for direct-contact membrane distillation
• Added thermal conductivity and viscosity to the water property package
• Added stoichiometric reactor model
• Added BSM2 flowsheet with phosphorus extension
• Added support for flash calculations with OLI Cloud API
• Added unit model test harness
• Added documentation for test harnesses
• Expanded GAC unit model to support mass basis property packages
• Refined pressure exchanger model to incorporate mixing and leakage
• Refined ASM2d/ADM1 translator block
• Refined and combined WaterTAP costing packages
• Removed obsolete and unused models and code

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