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 <https://pyomo.readthedocs.io/en/stable/pyomo_modeling_components/index.html>`_.

.. toctree::
    :maxdepth: 1
    :titlesonly:
    
    flowsheet/index
    property_package/index
    unit_model/index
    ui/index
    dmf/index

.. rubric:: Flowsheet

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

.. rubric:: Property Package

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

.. rubric:: Unit Model

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

.. rubric:: Data Management Framework

The :ref:`Data Management Framework <explanations/components/dmf/index:Data Management Framework>`
is used to manage data needed by the platform. It stores metadata and data in persistent storage.