.. raw:: html
.. role:: red
.. role:: green
.. role:: orange
.. role:: blue
.. role:: purple
API reference
-------------
BioSTEAM's main components can be categorized by 5 functionality levels:
.. figure:: ../images/UML.png
:width: 400
:class: only-light
:align: center
.. figure:: ../images/UML_dark.png
:width: 400
:class: only-dark
:align: center
- :blue:`Equipment` design, costing, and utility requirements are evaluated by :doc:`../API/Unit` objects. All built-in and custom unit operations are subclasses of Unit. Adjustments can be made to the heating and cooling agents of the :doc:`../API/HeatUtility` class (e.g., steam pressure, price) as well as the electricity price of the :doc:`../API/PowerUtility` class.
- :green:`Thermodynamic` equilibrium and mass and energy balances are facilitated by :doc:`../API/thermosteam/Stream` objects, which define material flows, temperature and pressure. Chemical properties and models are imported from `thermo `_, a community-driven open-source library developed by Caleb Bell.
- :orange:`Automation` of the simulation of large sets of scenarios is facilitated by :doc:`../API/evaluation/Model` objects which define :doc:`../API/evaluation/Parameter` and :doc:`../API/evaluation/Metric` objects that dictate the input and output features of the model.
- :red:`Simulation` is carried out by :doc:`../API/System` objects, which can be created without supplying any information on the order of unit simulation. After simulation, :doc:`../API/TEA` objects can perform cashflow analysis to solve for a number of financial indicators.
- :purple:`Biorefinery` models and results are available through the `Bioindustrial-Park `_. A number of key biorefinery systems for cellulosic pretreatment, fermentation, and product purification can be imported from the :doc:`biorefineries <../API/biorefineries/index>` library.
.. toctree::
:maxdepth: 2
:caption: Automation
:hidden:
evaluation/index
.. toctree::
:maxdepth: 2
:caption: Simulation
:hidden:
System
TEA
Flowsheet
process_tools/index
.. toctree::
:maxdepth: 2
:caption: Equipment
:hidden:
Unit
Facility
PowerUtility
UtilityAgent
HeatUtility
units/index
facilities/index
wastewater/index
.. toctree::
:maxdepth: 2
:caption: Thermodynamics
:hidden:
ThermoSTEAM
.. toctree::
:maxdepth: 2
:caption: Bioindustrial-Park
:hidden:
Biorefineries
.. toctree::
:maxdepth: 2
:caption: [Other]
:hidden:
exceptions
preferences
settings