Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.69 KB

index.rst

File metadata and controls

45 lines (33 loc) · 1.69 KB

Components

The purpose of this section of the documentation is to provide a general introduction to the top level components of the IDAES Integrated Platform. Each component is described in greater detail with a link in their description.

Note

IDAES is based on python-based algebraic modeling language, Pyomo. The documentation for its components (i.e. sets, parameters, variables, objectives, constraints, expressions, and suffixes) are provided in the Pyomo documentation.

.. toctree::
    :maxdepth: 1
    :titlesonly:

    flowsheet/index
    property_package/index
    unit_model/index
    dmf/index

Flowsheet

:ref:`Flowsheet models<user_guide/components/flowsheet/index:Flowsheet>` are the top level of the modeling heirachy. Flowsheet models represent traditional process flowsheets, containing a number of unit models connected together into a flow network and the property packages.

Property Package

:ref:`Property packages<user_guide/components/property_package/index:Property Package>` are a collection of related models that represent the physical, thermodynamic, and reactive properties of the process streams.

Unit Model

:ref:`Unit models<user_guide/components/unit_model/index:Unit Model>` represent individual pieces of equipment and their processes.

Data Management Framework

The :ref:`Data Management Framework <user_guide/components/dmf/index:Data Management Framework>` is used to manage all the data needed by the platform, including flowsheets, models, and results. It stores metadata and data in persistent storage.