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

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

• Add missing init.py files preventing MVC GUI from loading by @lbianchi-lbl in #1254
• added a couple of init files to make loop tools modules accessible when not installed in editable mode by @k1nshuk in #1255
• OARO 1D documentation by @luohezhiming in #1261
• Add limiting current density methods to electrodialysis_0D by @kejia6002 in #1242
• Add therm_cond_phase and visc_d_phase to water_prop_pack by @savannahsakhai in #1265
• GAC model for the UI by @hunterbarber in #1238
• Loosen idaes-pse requirement to include 2.3.x stable and 2.4 dev by @lbianchi-lbl in #1267
• Fix Binder IDAES solver configuration and Jupyter documentation by @lbianchi-lbl in #1275
• Fix DOF in IX costing function for single use resin and scale pumping power by @kurbansitterley in #1271
• BSM2 with P extension by @luohezhiming in #1276
• RO w/ERD Sweep Analysis by @MarcusHolly in #1177
• Add method for ParamterSweepTool to change lower/upper bounds, and fix/unfix variables. by @avdudchenko in #1268
• Adding stoichiometric reactor to WT by @avdudchenko in #1184
• Add functionality for input based model options by @MichaelPesce in #1270
• fix deprecation warnings in water and seawater prop packs by @savannahsakhai in #1282
• add continuous recirculation DCMD flowsheet by @ElmiraShamlou in #1260
• BSM2 Flowsheet Documentation by @MarcusHolly in #1263
• Revision of OLI Cloud Flash Calculations by @veccp in #1237
• update LCOW print in display_metrics of mvc flowsheet example by @savannahsakhai in #1281
• Unit Model Test Harness by @MarcusHolly in #1277
• Dye Desalination TEA Update by @MarcusHolly in #1278
• Use MultiChoiceCostingBlock in dye_desalination_withRO by @bknueven in #1291
• Test Harness Documentation by @MarcusHolly in #1288
• Fixing doctests for Pyomo 6.7.1 by @bknueven in #1310
• Work around for issue #1312 by @bknueven in #1316
• ASM2d/ADM1 Translator Update by @MarcusHolly in #1315
• Tinkering with BSM2 Optimization by @adam-a-a in #1244
• Make sure top-level model is not garbage collected in UnitTestHarness by @bknueven in #1317
• GAC Test Harness by @hunterbarber in #1311
• Resolve nbmake 1.5.1 errors on Windows by @lbianchi-lbl in #1322
• Clarifier, Crystallizer & RO Unit Test Harness by @MarcusHolly in #1301
• Require WaterTAP-specific kernel name for Jupyter notebooks testing by @lbianchi-lbl in #1320
• Electrolyzer Test Harness by @hunterbarber in #1321
• Changes to GAC model and GAC example flowsheet to solve when MaterialFlowBasis.mass by @hunterbarber in #1295
• Set acceptable_constr_viol_tol to 1e-08 by @bknueven in #1327
• Enable solver logs in Unit Test Harness by @bknueven in #1325
• Costing Unification: reorganize classes and consistent calculation of capital annualization by @bknueven in #1299
• Update idaes-pse requirement in preparation of 2.4 IDAES release by @lbianchi-lbl in #1309
• Updating copyright year to 2024 by @ksbeattie in #1329
• Upgrade pydantic version and update corresponding fsapi code by @MichaelPesce in #1330
• Add validity ranges and clean up water_prop_pack, seawater_prop_pack, and NaCl_T_dep_prop_pack by @savannahsakhai in #1304
• OLI API Flash update by @veccp in #1296
• add missed test for aeration tank by @adam-a-a in #1333
• Delete nf_0d files by @adam-a-a in #1334
• Remove selective oil permeation by @bknueven in #1336
• Remove full treatment train by @bknueven in #1335
• Add GUI for OARO by @luohezhiming in #1290
• Adding GAC into Dye Desalination w/RO by @MarcusHolly in #1294
• Minor MVC GUI Update by @MarcusHolly in #1338
• Add more detailed pressure exchanger by @luohezhiming in #1264
• add MD1D by @ElmiraShamlou in #1323
• Update Black to 24.3.0 by @lbianchi-lbl in #1339

Full Changelog: 0.11.0...0.12.0rc0

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: 0.10.0...0.11.0

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: 0.11.0rc1...0.11.0rc3