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

• General maintenance and improvements
• Added steam ejector unit model
• Modified the RO model to enable IDAES dynamics
• Updated the WaterTAP-OLI API and added more useful logger messages
• Refined the surrogate-based crystallizer
• Modified the MCAS property package to be compatible with the surrogate-based crystallizer
• Refined the dye desalination flowsheet
• Refined BSM2 models by adjusting scaling and removing simplified models

New Contributors

• @fahim831 made their first contribution in #1471
• @johnson12742 made their first contribution in #1524

Full Changelog: 1.1.0...1.2.0

1.2 Release Candidate #1

1.2 Release Candidate #1

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

WaterTAP 1.2.0rc1 Release Highlights

What's Changed

• BSM2-P Effluent Metrics w/o Flowsheet Constraints by @MarcusHolly in #1492
• Update Getting Started Documentation by @MarcusHolly in #1507
• Delete Simple Modified ASM2d by @MarcusHolly in #1506
• Add initialize function to fsapi by @MichaelPesce in #1501
• Enable RO0D to be dynamic by @fahim831 in #1471
• MCAS w/generic crystallizer by @adam-a-a in #1487
• Address CI failures described in #1514 by @lbianchi-lbl in #1515
• Exclude flexparser 0.4 as workaround for IDAES/idaes-pse#1524 by @lbianchi-lbl in #1521
• Update BSM2-P CSTR Model by @MarcusHolly in #1520
• Update IDAES requirement in preparation to 2.7.0 release by @lbianchi-lbl in #1526
• Update Costing in Dye Desal Flowsheet by @MarcusHolly in #1485
• Migrate watertap.ui.fsapi to idaes_flowsheet_processor by @lbianchi-lbl in #1518
• Delete Simple ASM2d Packages by @MarcusHolly in #1531
• Move get_solver test to more natural location by @bknueven in #1509
• Add molar flows for precipitate and reagent to simplify reaktoro integration by @avdudchenko in #1498
• Update looptool documentation by @johnson12742 in #1524
• Repair OLIAPI by @adam-a-a in #1512
• Fix Doc Typo in Flowsheet List by @MarcusHolly in #1539
• ASM1 Property Package Re-Scaling by @MarcusHolly in #1519
• Modified ADM1 Property Package Re-Scaling by @MarcusHolly in #1537
• Ensure no unhandled warnings are emitted during pytest run by @lbianchi-lbl in #1540
• Modified ASM2d model with new scaling tool by @luohezhiming in #1533
• Update Dye Desal Flowsheet Parameters by @MarcusHolly in #1528
• Update idaes-pse requirement to 2.7.0 by @lbianchi-lbl in #1534
• ADM1 Property Package Re-Scaling by @MarcusHolly in #1530
• Replace watertap.core.plugins with watertap_solvers by @lbianchi-lbl in #1541
• add TVC model by @ElmiraShamlou in #1516

New Contributors

• @fahim831 made their first contribution in #1471
• @johnson12742 made their first contribution in #1524

Full Changelog: 1.1.0...1.2.0rc1

1.2 Release Candidate #0

1.2 Release Candidate #0

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

WaterTAP 1.2.0rc0 Release Highlights

What's Changed

• BSM2-P Effluent Metrics w/o Flowsheet Constraints by @MarcusHolly in #1492
• Update Getting Started Documentation by @MarcusHolly in #1507
• Delete Simple Modified ASM2d by @MarcusHolly in #1506
• Add initialize function to fsapi by @MichaelPesce in #1501
• Enable RO0D to be dynamic by @fahim831 in #1471
• MCAS w/generic crystallizer by @adam-a-a in #1487
• Address CI failures described in #1514 by @lbianchi-lbl in #1515
• Exclude flexparser 0.4 as workaround for IDAES/idaes-pse#1524 by @lbianchi-lbl in #1521
• Update BSM2-P CSTR Model by @MarcusHolly in #1520
• Update IDAES requirement in preparation to 2.7.0 release by @lbianchi-lbl in #1526
• Update Costing in Dye Desal Flowsheet by @MarcusHolly in #1485
• Migrate watertap.ui.fsapi to idaes_flowsheet_processor by @lbianchi-lbl in #1518
• Delete Simple ASM2d Packages by @MarcusHolly in #1531
• Move get_solver test to more natural location by @bknueven in #1509
• Add molar flows for precipitate and reagent to simplify reaktoro integration by @avdudchenko in #1498
• Update looptool documentation by @johnson12742 in #1524
• Repair OLIAPI by @adam-a-a in #1512
• Fix Doc Typo in Flowsheet List by @MarcusHolly in #1539
• ASM1 Property Package Re-Scaling by @MarcusHolly in #1519
• Modified ADM1 Property Package Re-Scaling by @MarcusHolly in #1537
• Ensure no unhandled warnings are emitted during pytest run by @lbianchi-lbl in #1540
• Modified ASM2d model with new scaling tool by @luohezhiming in #1533
• Update Dye Desal Flowsheet Parameters by @MarcusHolly in #1528
• Update idaes-pse requirement to 2.7.0 by @lbianchi-lbl in #1534
• ADM1 Property Package Re-Scaling by @MarcusHolly in #1530
• Replace watertap.core.plugins with watertap_solvers by @lbianchi-lbl in #1541
• add TVC model by @ElmiraShamlou in #1516

New Contributors

• @fahim831 made their first contribution in #1471
• @johnson12742 made their first contribution in #1524

Full Changelog: 1.1.0...1.2.0rc0

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

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

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

• Convert enthalpies to base units in crystallizer property package by @OOAmusat in #1462
• OARO remove spiral-wound ModuleType by @zacharybinger in #1461
• Adding volume to MembraneChannel0D by @adam-a-a in #1465
• ADM1/ASM2d Translator Update by @MarcusHolly in #1435
• Debugging solver wrapper by @bknueven in #1287
• Add doc for debug solver wrapper and cleanup by @adam-a-a in #1470
• Add *args to action_wrapper by @MichaelPesce in #1475
• Remove xfail marker for Pyomo/pyomo#3295 by @lbianchi-lbl in #1484
• Add 0D Property Helper by @bknueven in #1477
• Add Modified ADM1 flowsheet by @luohezhiming in #1469
• Update BSM2-P Costing by @MarcusHolly in #1468
• Update IDAES requirement in preparation for 2.6 release by @lbianchi-lbl in #1486
• Add getattr for _BaseDebugSolverWrapper by @bknueven in #1490
• Add citation for the parameter sweep demo. by @k1nshuk in #1495
• adding LCOW per unit and per flow by @bknueven in #1398

Full Changelog: 1.0.0...1.1.0rc0

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

• 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)

Full Changelog: 0.12.0...1.0.0

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

• delete sw prop files by @adam-a-a in #1347
• Minor Dye Desalination Flowsheet Updates by @MarcusHolly in #1349
• Correct Handling of Sludge Product in BSM2 Flowsheets by @MarcusHolly in #1356
• improves compressor initialization by @ElmiraShamlou in #1350
• Implement get_solver for WaterTAP by @bknueven in #1353
• Use separate CI job for Codecov upload by @lbianchi-lbl in #1365
• Use separate CI job for Codecov upload for MPI workflow by @lbianchi-lbl in #1366
• modifies MD0D test to use unit test harness by @ElmiraShamlou in #1368
• Unit test harness for OARO models by @luohezhiming in #1367
• BSM2 Flowsheet Documentation Update by @MarcusHolly in #1354
• Pressure Changer and Coag & Floc Test Harness by @MarcusHolly in #1363
• Convert ipopt-watertap to a solver wrapper by @bknueven in #1326
• BSM2 flowsheet with electroNP by @luohezhiming in #1341
• Adding spiral-wound vs flat-sheet config options to RO and OARO by @zacharybinger in #1272
• Costing docs- initial template rollout by @adam-a-a in #1361
• Add SKK Documentation by @zacharybinger in #1342
• GUI for Extended BSM2 Flowsheet by @MarcusHolly in #1357
• Combine Dye Desal Flowsheets by @MarcusHolly in #1352
• Passing through the base solver attributes for solver wrapper by @bknueven in #1378
• Flowsheets documentation ADM1, ASM1, ASM2d by @agarciadiego in #1376
• Rename fsapi.FlowsheetExport dict() method and model_objects field to resolve Pydantic 2.0 warnings by @lbianchi-lbl in #1346
• Update idaes-pse requirement to support Pyomo 6.7.2 by @lbianchi-lbl in #1381
• CSTR and Clarifier Unit Model Documentation by @MarcusHolly in #1379
• Replacing Expr_if & Changing Bio_P Default by @MarcusHolly in #1362
• Adding Examples of Unit Model Costing Documentation by @MarcusHolly in #1373
• GAC costing documentation into template dedicated file by @hunterbarber in #1375
• Doc for second electrodialysis flowsheet by @lbibl in #1386
• Custom Model Demo Rework by @MarcusHolly in #1390
• Create landing page for tutorials by @lbianchi-lbl in #1178
• Use nbviewer for statically browsing tutorials by @lbianchi-lbl in #1399
• RO Parameter Estimation Tutorial by @zacharybinger in #1400
• Add documentation for electroNP, OARO and UV-AOP by @luohezhiming in #1377
• Update crystallizer costing documentation by @OOAmusat in #1391
• Add documentation for OARO flowsheet by @luohezhiming in #1351
• Electrolyzer costing documentation into template dedicated file by @hunterbarber in #1392
• Add More Costing Documentation by @MarcusHolly in #1395
• Apply UnitTestHarness to IonExchange0D by @kurbansitterley in #1401
• Update Costing Doc Automation by @MarcusHolly in #1394
• Flowsheet documentation for NaCl crystallizer by @OOAmusat in #1403
• Doc for electrodialysis flowsheet by @lbibl in #1385
• Extended BSM2 Flowsheet Costing by @MarcusHolly in #1405
• IonExchange0D costing documentation into template dedicated file by @kurbansitterley in #1402
• improved error message. by @k1nshuk in #1412
• Flowsheet Documentation for GAC by @hunterbarber in #1396
• test harness for unit models of waste treatment by @agarciadiego in #1371
• IX model small fix for anions in demo by @kurbansitterley in #1420
• Remove legacy WT3 data files by @kurbansitterley in #1422
• Fix RO Report Units by @zacharybinger in #1424
• Add chart options to fsapi by @MichaelPesce in #1413
• Update idaes-pse requirement in preparation to 2.5 release by @lbianchi-lbl in #1421
• Add more input options for OARO GUI by @luohezhiming in #1411
• Boron removal unit test harness by @savannahsakhai in #1415
• Flowsheet documentation for IX by @kurbansitterley in #1418
• Delete Simple IEDO GUI Flowsheets by @MarcusHolly in #1417
• Fix bubblepoint function and unit inconsistency in OLI API by @adam-a-a in #1388
• cyipopt-watertap by @bknueven in #1431
• Move unit specific property models into a new folder by @savannahsakhai in #1429
• Remove code, docs, and references for EDB by @lbianchi-lbl in #1432
• Exclude NumPy v2 when installing CyIpopt via conda-forge to resolve #1440 by @lbianchi-lbl in #1441
• Adding anaerobic digester cost by @agarciadiego in #1433
• Resolve Codecov upload failures by @lbianchi-lbl in #1448
• Remove Units from Report Strings by @MarcusHolly in #1428
• Interval Initializer by @bknueven in #1404
• Remove NF_With_Bypass flowsheet from UI by @MichaelPesce in #1436
• Flowsheet documentation for seawater RO desalination by @kurbansitterley in #1425
• Enable GreyBoxBlocks with cyipopt-watertap by @bknueven in #1434
• MVC Flowsheet Documentation by @MarcusHolly in #1430
• Update GHA macOS version to macos-13 since macos-11 is deprecated by @lbianchi-lbl in #1453
• Costing doc for stoichometric reactor by @avdudchenko in #1449
• add costing docs for evaporator, compressor, heat exchanger, heater/c… by @ElmiraShamlou in #1442
• ED Cost Documentation by @MarcusHolly in #1454
• add documentation for LSRRO flowsheet by @ElmiraShamlou in #1450
• add documentation for MD flowsheet by @ElmiraShamlou in #1444
• Flowsheet documentation for RO w/ ERD by @kurbansitterley in #1446
• Delete ZO Files by @MarcusHolly in #1438
• Adding Conservation Tests to the Test Harness by @MarcusHolly in #1416
• Enable concentration factor survey in OLI API by @adam-a-a in #1458
• Add documentation of pump and ERD by @luohezhiming in #1452
• Mixer Cost Documentation by @MarcusHolly in #1456
• Updating copyright year to 2024 by @ksbeattie in #1447
• Add LSRRO GUI by @MarcusHolly in #1383
• Ed UI by @lbibl in #1439
• Generic desalination treatment train by @avdudchenko in #1332
• Replace deprecated Pydantic parse_obj() method by @lbianchi-lbl in #1459
• Parameter Sweep migration by @lbianchi-lbl in #1437
• add steam heater and condenser by @ElmiraShamlou in #1358
• MCAS compatibility with ZO models by @adam-a-a in h...

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

• delete sw prop files by @adam-a-a in #1347
• Minor Dye Desalination Flowsheet Updates by @MarcusHolly in #1349
• Correct Handling of Sludge Product in BSM2 Flowsheets by @MarcusHolly in #1356
• improves compressor initialization by @ElmiraShamlou in #1350
• Implement get_solver for WaterTAP by @bknueven in #1353
• Use separate CI job for Codecov upload by @lbianchi-lbl in #1365
• Use separate CI job for Codecov upload for MPI workflow by @lbianchi-lbl in #1366
• modifies MD0D test to use unit test harness by @ElmiraShamlou in #1368
• Unit test harness for OARO models by @luohezhiming in #1367
• BSM2 Flowsheet Documentation Update by @MarcusHolly in #1354
• Pressure Changer and Coag & Floc Test Harness by @MarcusHolly in #1363
• Convert ipopt-watertap to a solver wrapper by @bknueven in #1326
• BSM2 flowsheet with electroNP by @luohezhiming in #1341
• Adding spiral-wound vs flat-sheet config options to RO and OARO by @zacharybinger in #1272
• Costing docs- initial template rollout by @adam-a-a in #1361
• Add SKK Documentation by @zacharybinger in #1342
• GUI for Extended BSM2 Flowsheet by @MarcusHolly in #1357
• Combine Dye Desal Flowsheets by @MarcusHolly in #1352
• Passing through the base solver attributes for solver wrapper by @bknueven in #1378
• Flowsheets documentation ADM1, ASM1, ASM2d by @agarciadiego in #1376
• Rename fsapi.FlowsheetExport dict() method and model_objects field to resolve Pydantic 2.0 warnings by @lbianchi-lbl in #1346
• Update idaes-pse requirement to support Pyomo 6.7.2 by @lbianchi-lbl in #1381
• CSTR and Clarifier Unit Model Documentation by @MarcusHolly in #1379
• Replacing Expr_if & Changing Bio_P Default by @MarcusHolly in #1362
• Adding Examples of Unit Model Costing Documentation by @MarcusHolly in #1373
• GAC costing documentation into template dedicated file by @hunterbarber in #1375
• Doc for second electrodialysis flowsheet by @lbibl in #1386
• Custom Model Demo Rework by @MarcusHolly in #1390
• Create landing page for tutorials by @lbianchi-lbl in #1178
• Use nbviewer for statically browsing tutorials by @lbianchi-lbl in #1399
• RO Parameter Estimation Tutorial by @zacharybinger in #1400
• Add documentation for electroNP, OARO and UV-AOP by @luohezhiming in #1377
• Update crystallizer costing documentation by @OOAmusat in #1391
• Add documentation for OARO flowsheet by @luohezhiming in #1351
• Electrolyzer costing documentation into template dedicated file by @hunterbarber in #1392
• Add More Costing Documentation by @MarcusHolly in #1395
• Apply UnitTestHarness to IonExchange0D by @kurbansitterley in #1401
• Update Costing Doc Automation by @MarcusHolly in #1394
• Flowsheet documentation for NaCl crystallizer by @OOAmusat in #1403
• Doc for electrodialysis flowsheet by @lbibl in #1385
• Extended BSM2 Flowsheet Costing by @MarcusHolly in #1405
• IonExchange0D costing documentation into template dedicated file by @kurbansitterley in #1402
• improved error message. by @k1nshuk in #1412
• Flowsheet Documentation for GAC by @hunterbarber in #1396
• test harness for unit models of waste treatment by @agarciadiego in #1371
• IX model small fix for anions in demo by @kurbansitterley in #1420
• Remove legacy WT3 data files by @kurbansitterley in #1422
• Fix RO Report Units by @zacharybinger in #1424
• Add chart options to fsapi by @MichaelPesce in #1413
• Update idaes-pse requirement in preparation to 2.5 release by @lbianchi-lbl in #1421
• Add more input options for OARO GUI by @luohezhiming in #1411
• Boron removal unit test harness by @savannahsakhai in #1415
• Flowsheet documentation for IX by @kurbansitterley in #1418
• Delete Simple IEDO GUI Flowsheets by @MarcusHolly in #1417
• Fix bubblepoint function and unit inconsistency in OLI API by @adam-a-a in #1388
• cyipopt-watertap by @bknueven in #1431
• Move unit specific property models into a new folder by @savannahsakhai in #1429
• Remove code, docs, and references for EDB by @lbianchi-lbl in #1432
• Exclude NumPy v2 when installing CyIpopt via conda-forge to resolve #1440 by @lbianchi-lbl in #1441
• Adding anaerobic digester cost by @agarciadiego in #1433
• Resolve Codecov upload failures by @lbianchi-lbl in #1448
• Remove Units from Report Strings by @MarcusHolly in #1428
• Interval Initializer by @bknueven in #1404
• Remove NF_With_Bypass flowsheet from UI by @MichaelPesce in #1436
• Flowsheet documentation for seawater RO desalination by @kurbansitterley in #1425
• Enable GreyBoxBlocks with cyipopt-watertap by @bknueven in #1434
• MVC Flowsheet Documentation by @MarcusHolly in #1430
• Update GHA macOS version to macos-13 since macos-11 is deprecated by @lbianchi-lbl in #1453
• Costing doc for stoichometric reactor by @avdudchenko in #1449
• add costing docs for evaporator, compressor, heat exchanger, heater/c… by @ElmiraShamlou in #1442
• ED Cost Documentation by @MarcusHolly in #1454
• add documentation for LSRRO flowsheet by @ElmiraShamlou in #1450
• add documentation for MD flowsheet by @ElmiraShamlou in #1444
• Flowsheet documentation for RO w/ ERD by @kurbansitterley in #1446
• Delete ZO Files by @MarcusHolly in #1438
• Adding Conservation Tests to the Test Harness by @MarcusHolly in #1416
• Enable concentration factor survey in OLI API by @adam-a-a in #1458
• Add documentation of pump and ERD by @luohezhiming in #1452
• Mixer Cost Documentation by @MarcusHolly in #1456
• Updating copyright year to 2024 by @ksbeattie in #1447
• Add LSRRO GUI by @MarcusHolly in #1383
• Ed UI by @lbibl in #1439
• Generic desalination treatment train by @avdudchenko in #1332
• Replace deprecated Pydantic parse_obj() method by @lbianchi-lbl in #1459
• Parameter Sweep migration by @lbianchi-lbl in #1437
• add steam heater and condenser by @ElmiraShamlou in #1358
• MCAS compatibility with ZO models by @adam-a-a in h...

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

• 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

Full Changelog: 0.11.0...0.12.0