1.5 Release

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