Idaes-pse

- New modules for modular property packages which allow interfacing with CoolProp (external, open-source thermophysical property package)
- Added new `InitializationError` type which is now raised whenever an initialization routine fails to solve successfully. Updated all core models to raise this error on failure
- Initialization improvements for systems with vapor-liquid equilibrium.
- New solver interface which allows the use of PETSc solver library, including interface for solving (P)DAE systems
- Updated CLC methane reduction property packages for gas-solid contactor models to use standard base units, including example flowsheet modifications for energy in J and pressure in Pa
- Clean up of some power generation models to bring them more in-line with IDAES modeling standards
- Improvements in external functions for calculating roots of cubics and cubic equations of state
- Bug fixes in ALAMOpy wrapper to correctly support validation data sets

Python version support

- Support for Python 3.10 has been added
- Support for Python 3.6 has been removed

ADVANCE CHANGE NOTICE: Upcoming IDAES v2

We are pleased to announce that IDAES v2 is under development. IDAES v2 introduces significant improvements and API changes with respect to the current (v1) codebase.
In order to provide advance warning of the upcoming changes and minimize their impact on functionality during this transition, the following schedule is planned for the next 9 months:

- The first stable version of IDAES v2, release 2.0.0, is currently planned for November 2022
- The current release series, 1.13, will be the last for the IDAES v1 codebase
- Over the intervening months, as part of our quarterly release cycle, we will be releasing preview versions of the v2 codebase. If applicable, we will also distribute bugfixes that are compatible with the v1 codebase as patch releases to the 1.13 release series (1.13.1, 1.13.2)
- During this time, changes to the IDAES API introduced by v2 will be documented as deprecation warnings in the codebase and/or as part of the release notes
- Once the 2.0.0 release is out, all deprecation warnings will be removed, and support will switch to IDAES v2 only

We encourage our users to follow these changes closely over the next few months and adapt their models accordingly in preparation to the 2.0.0 release.

- Fixed bug in generic properties initialization (647)
- Pinned IPython requirement to exclude incompatible version 8.0.0 (661)

- Deprecations:
- Python 3.6 support is deprecated and it will be removed with the next IDAES release
- Deprecation warning: `generic_models.unit_models.distillation` folder renamed to ` generic_models.unit_models.column_models`
- Removed support for directly setting `state_block_class` and `reaction_block_class` in property and reaction packages
- Removed support for property packages which do not use Phase and Component objects
- Removed support for defining units of measurement via strings.
- Removed support for dynamic simulations without specifying units for time domain
- Improved workflow and interface for developing surrogate models and incorporating these into flowsheets
- Improved wrapper for ALAMO using new surrogate interface
- New Unit models:
- Condenser and Reboiler for packed column applications
- 0-D Heat Exchanger using the NTU method
- Ability to use external variable for `length` in 1-D control volumes
- Thermophysical and transport properties:
- New supported properties: Cp, Cv, diffusivity, thermal conductivity, speed of sound, surface tension, viscosity
- Improved formulation of log expressions
- Surrogate modeling using Keras
- This requires `tensorflow`, which is an optional dependency of IDAES. To install it, use any one of the following commands:

sh
conda install tensorflow
pip install tensorflow
pip install "idaes-pse[optional]" this will install all optional dependencies for IDAES, including tensorflow
`

- New component: SkeletonUnitModel – a generic unit model object for surrogate and custom unit models
- Improving access to time domain: All Flowsheets now have a ‘time’ property which will return the local time domain
- Support for additional properties in Generic Property Framework: Ideal solids, Henry’s Law, molar volume, osmotic pressure, diffusivity and viscosity
- Improved scaling methods for Mixer and Separator
- Updating some imports from Pyomo due to changes in Pyomo 6.1
- Prototype support for precipitation reactions using solubility products (still needs refinement)

Deprecation warnings slated to be removed (and becoming errors) in next release
- Directly setting `state_block_class` and `reaction_block_class` when creating property packages will no longer be allowed: users should set `_state_block_class` and `_reaction_block_class` instead.
- Old style property packages that do not use `Phase` and `Component` objects will no longer be supported (i.e. those that create the `phase_list` and `component_set` directly).
- IDAES will no longer support using strings to defining units of measurement in property packages. Property developers should use Pyomo units (or `None`) instead.
- Users will need to define units for the time domain in dynamic simulations.

- New component: SkeletonUnitModel – a generic unit model object for surrogate and custom unit models
- Improving access to time domain: All Flowsheets now have a ‘time’ property which will return the local time domain
- Support for additional properties in Generic Property Framework: Ideal solids, Henry’s Law, molar volume, osmotic pressure, diffusivity and viscosity
- Improved scaling methods for Mixer and Separator
- Updating some imports from Pyomo due to changes in Pyomo 6.1
- Prototype support for precipitation reactions using solubility products (still needs refinement)

Deprecation warnings slated to be removed (and becoming errors) in next release
- Directly setting `state_block_class` and `reaction_block_class` when creating property packages will no longer be allowed: users should set `_state_block_class` and `_reaction_block_class` instead.
- Old style property packages that do not use `Phase` and `Component` objects will no longer be supported (i.e. those that create the `phase_list` and `component_set` directly).
- IDAES will no longer support using strings to defining units of measurement in property packages. Property developers should use Pyomo units (or `None`) instead.
- Users will need to define units for the time domain in dynamic simulations.