IDAES Tutorials and Examples

The IDAES integrated platform (IDAES-IP) ships with a number of examples cotained in Jupyter notebooks which can be run on the user’s own computer. This page provides links to pre-generated forms of these examples. For instructions on downloading and running them on your own computer, see the IDAES-IP main documentation page.

Although all the files are examples in the broad sense, the distinction here between “Examples” and “Tutorials” is the amount of didactic content. In particular, Jupyter notebooks in the “Tutorials” section contain explicit exercise and solution cells (a cell is a section of code or text in a Jupyter notebook), whereas the “Examples” notebooks do not. When you download these examples to your own computer, for the tutorial notebooks you can choose to run the version that has only the exercises and no solutions.

Contents

• Examples
  • Advanced
    • Custom unit models
      • Custom Compressor
      • Custom Heater
    • Custom properties
      • Custom Physical Property Packages
      • Custom Reaction Property Packages
    • Data reconciliation
      • Boiler Flowsheet Recon
      • Econ Recon
      • Econ Parmest
  • Flowsheets
    • Hda Flowsheet With Distillation Solution
    • Hda Flowsheet With Costing
    • Methanol Synthesis
    • Power Generation Flowsheets
      • Flowsheets
        • Ngcc
      • Flowsheets
        • Ngfc Flowsheet
      • Flowsheets
      • Flowsheets
      • Flowsheets
        • Sofc
      • Flowsheets
      • Flowsheets
        • Subcritical Boiler
      • Flowsheets
        • Supercritical Steam Cycle
        • Supercritical Power Plant
    • Flowsheets
      • Co2 Adsorption Desorption Example 1Dfixedbed
  • MatOpt
    • Monometallic Nanocluster Design
    • Bimetallic Nanocluster Design
    • Surface Design
    • Bifunctional Surface Design
    • Metal Oxide Bulk Design
    • Nanowire Design
  • Surrogate modeling
    • FlowsheetOptimization
      • Pysmo Flowsheet Optimization
      • Keras Flowsheet Optimization
      • Best Practices Optimization
    • PySMO
      • Pysmo Basics
  • Tools
    • Data Management Framework
    • Degeneracy Hunter
  • Unit models
    • Operations
      • Compressor
      • Feed
      • Feed Flash
      • Flash
      • Heater
      • Heat Exchanger 0D
        • Importing necessary tools
        • Setting up the flowsheet
        • Fixing input specifications
          • Option 1: Fix overall heat transfer coefficient (HTC) and the heat transfer area
          • Option 2: Unfix area and fix shell side outlet temperature
      • Heat Exchanger 1D
        • Importing necessary tools
        • Setting up the flowsheet
        • Fixing input specifications
          • Option 1: Fix heat transfer coefficient (HTC) and dimensions of each domain
          • Option 2: Unfix shell length and fix shell outlet temperatures
      • Heat Exchanger lc
        • Importing necessary tools
        • Setting up the flowsheet
        • Fixing input specifications
          • Fix overall heat transfer coefficient (HTC) and the heat transfer area
      • Heat Exchanger NTU
        • Importing necessary tools
        • Setting up the flowsheet
        • Fixing input specifications
          • Option 1: Fix heat transfer coefficient (HTC) and dimensions of each domain
          • Option 2: Unfix shell length and fix shell outlet temperatures
      • Mixer
      • Product
      • Pump
      • Separator
      • Statejunction
      • Translator
      • Turbine
      • Valve
    • Unit models
      • Cstr
      • Equilibrium Reactor
      • Gibbs Reactor
      • Plug Flow Reactor
      • Stoichiometric Reactor
  • Pecos
    • Data quality control
• IDAES Tutorials
  • Basic tutorials
    • Short introduction to Python and Pyomo
    • Longer introduction to Python and Pyomo
    • Flash Unit Solution
    • Hda Flowsheet Solution
  • Advanced Tutorials
    • Advanced Parameter Estimation
      • Use Pyomo's parmest tool and IDAES state blocks
      • Use Pyomo's parmest tool and IDAES unit models

Copyright

Institute for the Design of Advanced Energy Systems Process Systems Engineering Framework (IDAES PSE Framework) was produced under the DOE Institute for the Design of Advanced Energy Systems (IDAES), and is copyright (c) 2018-2020 by the software owners: The Regents of the University of California, through Lawrence Berkeley National Laboratory, National Technology & Engineering Solutions of Sandia, LLC, Carnegie Mellon University, West Virginia University Research Corporation, et al. All rights reserved.

NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit other to do so. Copyright (C) 2018-2020 IDAES - All Rights Reserved

License

Institute for the Design of Advanced Energy Systems Process Systems Engineering Framework (IDAES PSE Framework) Copyright (c) 2018-2020, by the software owners: The Regents of the University of California, through Lawrence Berkeley National Laboratory, National Technology & Engineering Solutions of Sandia, LLC, Carnegie Mellon University, West Virginia University Research Corporation, et al. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the Institute for the Design of Advanced Energy Systems (IDAES), University of California, Lawrence Berkeley National Laboratory, National Technology & Engineering Solutions of Sandia, LLC, Sandia National Laboratories, Carnegie Mellon University, West Virginia University Research Corporation, U.S. Dept. of Energy, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code (“Enhancements”) to anyone; however, if you choose to make your Enhancements available either publicly, or directly to Lawrence Berkeley National Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant Lawrence Berkeley National Laboratory the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.