Releases: IDAES/idaes-pse
Releases · IDAES/idaes-pse
2.4 Release
2.4 Release
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.4.0 Release Highlights
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
2.4 Release Candidate #0
2.4 Release Candidate #0
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.4.0rc0 Release Highlights
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
2.3 Release
2.3 Release
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.3.0 Release Highlights
New Features and Models
- New diagnostics toolboxes and examples
- Tutorial for using the DiagnosticsToolbox
- Methods to identify potential evaluation errors in models
SVDToolboxfor 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 #1294. Offers to help identify the cause and fix this issue are welcome.
Improvements and bug fixes
- Fixed oversight which precluded using
MixerandSeparatormodels when inherent reactions were present in property package - Added reporting methods to the
MSContactormodel - Minor corrections in some examples where values were being fixed outside of declared variable bounds
2.3 Release Candidate #2
2.3 Release Candidate #2
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.3.0rc2 Release Highlights
New Features and Models
- New diagnostics toolboxes and examples
- Tutorial for using the DiagnosticsToolbox
- Methods to identify potential evaluation errors in models
SVDToolboxfor 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 #1294. Offers to help identify the cause and fix this issue are welcome.
Improvements and bug fixes
- Fixed oversight which precluded using
MixerandSeparatormodels when inherent reactions were present in property package - Added reporting methods to the
MSContactormodel - Minor corrections in some examples where values were being fixed outside of declared variable bounds
2.3 Release Candidate #1
2.3 Release Candidate 1
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.3.0rc1 Release Highlights
New Features and Models
- New diagnostics toolboxes and examples
- Tutorial for using the DiagnosticsToolbox
- Methods to identify potential evaluation errors in models
SVDToolboxfor 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 #1294. Offers to help identify the cause and fix this issue are welcome.
Improvements and bug fixes
- Fixed oversight which precluded using
MixerandSeparatormodels when inherent reactions were present in property package - Added reporting methods to the
MSContactormodel - Minor corrections in some examples where values were being fixed outside of declared variable bounds
2.3 Release Candidate #0
2.3 Release Candidate #0
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.3.0rc0 Release Highlights
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 #1294. Offers to help identify the cause and fix this issue are welcome.
Improvements and bug fixes
- Fixed oversight which precluded using
MixerandSeparatormodels when inherent reactions were present in property package - Added reporting methods to the
MSContactormodel - Minor corrections in some examples where values were being fixed outside of declared variable bounds
2.2 Release
2.2 Release
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.2.0 Release Highlights
New Features: DiagnosticsToolbox
DiagnosticsToolbox (idaes.core.util.model_diagnostics.DiagnosticsToolbox is a new self-guiding toolbox for assisting with diagnosing modeling issues. The toolbox contains a wide range of tools for identifying common modeling issues and conveying these to the user, and more features will be added in the coming months.
To try the new toolbox, use the following steps:
from idaes.core.util import DiagnosticsToolbox- Build an instance of your model
- Ensure your models has zero degrees of freedom (as best you can)
dt = DiagnosticsToolbox(model)dt.report_structural_issues()- Follow the prompts
Deprecations
- DegeneracyHunter is being deprecated in favor of the new DiagnosticsToolbox. The features and capabilities of DegeneracyHunter will be moved over to the DiagnositcsToolbox in the coming months.
- Removal of usage of Pyomo's
expr.currentdue to deprecation upstream. - Removed support for radial basis functions in ALAMOpy as these did not work in the current implementation. Those wishing to use radial basis functions should use Pysmo instead.
New Capabilities
- MSContactor model for unit operations involving mass transfer between 2 or more streams, such as membrane, solvent extraction and solids leaching operations.
Other Improvements
- Improved formulation for solubility products with additional parameters for better scaling of terms
- Better backward compatibility, verification and robustness testing of core models and APIs
- Added support for Separator models without energy balances
2.2 Release Candidate #1
2.2 Release Candidate #1
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.2.0rc1 Release Highlights
New Features: DiagnosticsToolbox
DiagnosticsToolbox (idaes.core.util.model_diagnostics.DiagnosticsToolbox is a new self-guiding toolbox for assisting with diagnosing modeling issues. The toolbox contains a wide range of tools for identifying common modeling issues and conveying these to the user, and more features will be added in the coming months.
To try the new toolbox, use the following steps:
from idaes.core.util import DiagnosticsToolbox- Build an instance of your model
- Ensure your models has zero degrees of freedom (as best you can)
dt = DiagnostisticsToobox(model)dt.report_strucutral_issues()- Follow the prompts
Deprecations
- DegeneracyHunter is being deprecated in favor of the new DiagnosticsToolbox. The features and capabilities of DegeneracyHunter will be moved over to the DiagnositcsToolbox in the coming months.
- Removal of usage of Pyomo's
expr.currentdue to deprecation upstream. - Removed support for radial basis functions in ALAMOpy as these did not work in the current implementation. Those wishing to use radial basis functions should use Pysmo instead.
New Capabilities
- MSContactor model for unit operations involving mass transfer between 2 or more streams, such as membrane, solvent extraction and solids leaching operations.
Other Improvements
- Improved formulation for solubility products with additional parameters for better scaling of terms
- Better backward compatibility, verification and robustness testing of core models and APIs
- Added support for Separator models without energy balances
2.2.0 Release Candidate #0
2.2.0 Release Candidate #0
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.2.0rc0 Release Highlights
New Features: DiagnosticsToolbox
DiagnosticsToolbox (idaes.core.util.model_diagnostics.DiagnosticsToolbox is a new self-guiding toolbox for assisting with diagnosing modeling issues. The toolbox contains a wide range of tools for identifying common modeling issues and conveying these to the user, and more features will be added in the coming months.
To try the new toolbox, use the following steps:
from idaes.core.util import DiagnosticsToolbox- Build an instance of your model
- Ensure your models has zero degrees of freedom (as best you can)
dt = DiagnostisticsToobox(model)dt.report_strucutral_issues()- Follow the prompts
Deprecations
- DegeneracyHunter is being deprecated in favor of the new DiagnosticsToolbox. The features and capabilities of DegeneracyHunter will be moved over to the DiagnositcsToolbox in the coming months.
- Removal of usage of Pyomo's
expr.currentdue to deprecation upstream. - Removed support for radial basis functions in ALAMOpy as these did not work in the current implementation. Those wishing to use radial basis functions should use Pysmo instead.
New Capabilities
- MSContactor model for unit operations involving mass transfer between 2 or more streams, such as membrane, solvent extraction and solids leaching operations.
Other Improvements
- Improved formulation for solubility products with additional parameters for better scaling of terms
- Better backward compatibility, verification and robustness testing of core models and APIs
- Added support for Separator models without energy balances
2023 May Release
2023 May Release
Start with our online documentation to get started with install instructions, examples, etc.
IDAES-PSE 2.1.0 Release Highlights
New IDAES Examples Repository
Starting with this release, the IDAES examples are developed in the new IDAES/examples repository.
Along with many content and usability improvements, the most significant changes are:
- To install the examples, after installing IDAES, run
pip install idaes-examples- The
idaes get-examplescommand, previously used for this, has been removed
- The
- The HTML version is now available at https://idaes-examples.readthedocs.io
- The previous URL, https://idaes.github.io/examples-pse, will not be updated and may be removed at some point in the future
For more details, refer to the resources available at IDAES/examples.
Removal of Non-Functional Apps
A review of the code in the idaes/apps and idaes/models_extra folders was undertaken, and a number of tools were identified as being outdated or non-functional and no longer supported by their development teams. Due to this, the following tools have been removed:
idaes/apps/alamopy_depr (note that the new ALAMOpy interface remains avaialble in idaes/core/surrogates)
idaes/apps/helmet
idaes/apps/ripe
idaes/apps/roundingRegression
idaes/models_extra/carbon_capture
Pyomo 6.6
This version of IDAES is the first requiring Pyomo 6.6. This version of Pyomo contains multiple internal improvements and refactorings.
While for the majority of cases this should have positive or no impact on solvability of IDAES models, we are aware of a small number of models that have been affected as a result of these changes.
For more information, refer to the Pyomo 6.6.1 release notes.
Other highlights
- Model Initialization
- A prototype API for a new approach to initializing IDAES models is now available which makes available some new techniques for initializing models. This is documented in the Initializing Models Reference Guide
- Modular Properties Framework
- Support for some transport properties
- Helmholtz Equation of State properties
- Better error checking for case where unit models are set to include phase equilibrium but the property package is set to support only a single phase
- Multi-Stream Contactor model: a new base model for systems involving contacting of two or more streams with mass transfer. This model is intended to be used as the foundation for models such as membrane separators, solvent extraction and other similar processes. This is documented in the Multi-Stream Contactor Reference Guide
idaes/models_extra/power_generationreport()methods for unit models using Helmholtz equation of state
- General Code Maintenance
- Streamlining of dependencies and creation of new optional dependency groupings to support non-core tools
- General linting of codebase to ensure compliance with most pylint checks
- Spell checking of all code and doc strings
- Removal of backward compatibility code for Python 2