Watertap

Start with our [online documentation](https://watertap.readthedocs.org/en/0.12.0rc0) to get started with install instructions, examples, etc.

- 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**: https://github.com/watertap-org/watertap/compare/0.11.0...0.12.0

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


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

Start with our [online documentation](https://watertap.readthedocs.org/en/0.11.0rc1) to get started with install instructions, examples, etc.

- 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

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