Idaes-pse

Deprecations

- Convergence Analysis tool (idaes/core/util/convergence): deprecated in favor of new Parameter Sweep tools. To be removed in v3.0.0.

New Beta Capabilities

- Parameter Sweep Tool (`idaes.core.util.parameter_sweep`)
- A new API for defining and performing parameter sweep studies on IDAES models has been developed
- Diagnostics Tools (`idaes.core.util.model_diagnostics`)
- New methods for identifying duplicate variables and constraints have been added to the diagnostics toolbox
- New tools for detecting ill conditioning in Jacobians have been developed and are available in the model_diagnostics module. These provide alternatives to the existing DegeneracyHunter toolbox, and will eventually be merged with this capability, but initial working versions have been provided as beta capabilities for interested users
- `IpoptConvergenceAnalysis` (replaces deprecated Convergence Analysis tool):
- A new tool for performing convergence analysis studies that leverages the new Parameter Sweep tools has been developed. This tool allows users to define the input parameters to their model and sampling methods for these (leveraging Pysmo's sampling tools) and to then solve their model across the sampled domains and return a summary of the solver performance (IPOPT only)

Improved Models

- Thickener model (`idaes.models.unit_models.solid_liquid.thickener`)
- Improved model to include predictive correlations for unit sizing based on settling velocity measurements (steady-state only)
- Modular Property Packages
- Added general support for calculating critical properties of mixtures using defined Equation of State modules. New API defined for Equation of State modules in order to define the necessary constraints for calculating critical properties (most EoS modules DO NOT support calculation of critical properties (yet))
- Added new methods to Cubic Equation of State module to support calculation of critical properties

Deprecations

- Convergence Analysis tool (idaes/core/util/convergence): deprecated in favor of new Parameter Sweep tools. To be removed in v3.0.0.

New Beta Capabilities

- Parameter Sweep Tool (`idaes.core.util.parameter_sweep`)
- A new API for defining and performing parameter sweep studies on IDAES models has been developed
- Diagnostics Tools (`idaes.core.util.model_diagnostics`)
- New methods for identifying duplicate variables and constraints have been added to the diagnostics toolbox
- New tools for detecting ill conditioning in Jacobians have been developed and are available in the model_diagnostics module. These provide alternatives to the existing DegeneracyHunter toolbox, and will eventually be merged with this capability, but initial working versions have been provided as beta capabilities for interested users
- `IpoptConvergenceAnalysis` (replaces deprecated Convergence Analysis tool):
- A new tool for performing convergence analysis studies that leverages the new Parameter Sweep tools has been developed. This tool allows users to define the input parameters to their model and sampling methods for these (leveraging Pysmo's sampling tools) and to then solve their model across the sampled domains and return a summary of the solver performance (IPOPT only)

Improved Models

- Thickener model (`idaes.models.unit_models.solid_liquid.thickener`)
- Improved model to include predictive correlations for unit sizing based on settling velocity measurements (steady-state only)
- Modular Property Packages
- Added general support for calculating critical properties of mixtures using defined Equation of State modules. New API defined for Equation of State modules in order to define the necessary constraints for calculating critical properties (most EoS modules DO NOT support calculation of critical properties (yet))
- Added new methods to Cubic Equation of State module to support calculation of critical properties

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

New Features and Models

- New diagnostics toolboxes and examples
- Tutorial for using the DiagnosticsToolbox
- Methods to identify potential evaluation errors in models
- `SVDToolbox` for performing singular value decomposition analysis on models to identify possible degeneracies and poor scaling
- DegeneracyHunter for identifying irreducible degenerate sets in models
- Model for solid-liquid separation which takes two inputs (solid and liquid streams) and produces three outlets (solids, liquid entrained with solids and pure liquid)
- Example of temperature swing adsorption in `models_extra`

Deprecation Warnings

- With the update to Pyomo 6.7.0, the plate heat exchanger model has begun failing tests on some CI platforms. If this is not addressed by the February release, this model may be removed due to failing tests. See https://github.com/IDAES/idaes-pse/issues/1294. Offers to help identify the cause and fix this issue are welcome.

Improvements and bug fixes

- Fixed oversight which precluded using `Mixer` and `Separator` models when inherent reactions were present in property package
- Added reporting methods to the `MSContactor` model
- Minor corrections in some examples where values were being fixed outside of declared variable bounds

New Features and Models

- New diagnostics toolboxes and examples
- Tutorial for using the DiagnosticsToolbox
- Methods to identify potential evaluation errors in models
- `SVDToolbox` for performing singular value decomposition analysis on models to identify possible degeneracies and poor scaling
- DegeneracyHunter for identifying irreducible degenerate sets in models
- Model for solid-liquid separation which takes two inputs (solid and liquid streams) and produces three outlets (solids, liquid entrained with solids and pure liquid)
- Example of temperature swing adsorption in `models_extra`

Deprecation Warnings

- With the update to Pyomo 6.7.0, the plate heat exchanger model has begun failing tests on some CI platforms. If this is not addressed by the February release, this model may be removed due to failing tests. See https://github.com/IDAES/idaes-pse/issues/1294. Offers to help identify the cause and fix this issue are welcome.

Improvements and bug fixes

- Fixed oversight which precluded using `Mixer` and `Separator` models when inherent reactions were present in property package
- Added reporting methods to the `MSContactor` model
- Minor corrections in some examples where values were being fixed outside of declared variable bounds

New Features and Models

- New diagnostics toolboxes and examples
- Tutorial for using the DiagnosticsToolbox
- Methods to identify potential evaluation errors in models
- `SVDToolbox` for performing singular value decomposition analysis on models to identify possible degeneracies and poor scaling
- DegeneracyHunter for identifying irreducible degenerate sets in models
- Model for solid-liquid separation which takes two inputs (solid and liquid streams) and produces three outlets (solids, liquid entrained with solids and pure liquid)
- Example of temperature swing adsorption in `models_extra`

Deprecation Warnings

- With the update to Pyomo 6.7.0, the plate heat exchanger model has begun failing tests on some CI platforms. If this is not addressed by the February release, this model may be removed due to failing tests. See https://github.com/IDAES/idaes-pse/issues/1294. Offers to help identify the cause and fix this issue are welcome.

Improvements and bug fixes

- Fixed oversight which precluded using `Mixer` and `Separator` models when inherent reactions were present in property package
- Added reporting methods to the `MSContactor` model
- Minor corrections in some examples where values were being fixed outside of declared variable bounds