API Reference

hensmith exports thirteen names. HeatExchangerNetwork is the BioSTEAM facility most users need; the functions and classes of hensmith.hxn_synthesis are the pinch analysis and synthesis machinery behind it, usable on their own; and those of hensmith.targeting target utilities, area, units, capital and total annualized cost, find the T_min_app of the least targeted total annualized cost, and compare a network with its targets.

HeatExchangerNetwork([ID, T_min_app, units, ...])	Create a HeatExchangerNetwork object that will perform a pinch analysis on the entire system's heating and cooling utility objects.
problem_table(streams_inlet, ...[, curves, ...])	Energy-consistent problem table (temperature-interval heat cascade).
ProblemTable(Ts, interval_H, point_H, ...)	Result of problem_table: the temperature-interval heat cascade of a set of process streams on the shifted temperature scale (hot streams shifted down by the minimum approach temperature, cold streams unshifted; with approach contributions every stream by its own shift, see problem_table).
synthesize_network(hus[, T_min_app, Qmin, ...])	Synthesize a heat exchanger network for the process streams behind a set of utility heat exchangers: pinch analysis (problem_table), then a pinch-outward plan that reaches the minimum energy requirement (MER) targets whenever the search finds an unsplit network that does, realized with one HXprocess per match and one rigorous HXutility per stream.
StreamLifeCycle(index, cold)	The ordered sequence of heat exchangers one process stream passes through in a synthesized heat exchanger network, from its inlet state to its final utility exchanger.
plot_pinch_diagram(stream_life_cycles, ...)	Draw a pinch diagram of a synthesized heat exchanger network: cold streams (blue, flowing left to right) above hot streams (red, flowing right to left), one vertical connector per process heat exchanger with its duty, a dashed pinch line separating the cold-side from the hot-side exchangers, and circles marking the utility exchangers that bring each stream to its outlet temperature.
PinchTargets(streams_inlet, ...[, ...])	Pinch analysis targets of a set of process streams: the problem table (hensmith.hxn_synthesis.problem_table) and what follows from it, the composite and grand composite curves, the targets of several utilities (utility_targets) priced by biosteam, the balanced composite curves, and the targets of area, units, capital cost and total annualized cost (summary).
supertarget(targets[, T_min_apps, refine, ...])	Sweep the minimum approach temperature for the least total annualized cost (TAC) target: supertargeting [Ahmad90].
Supertargets(targets, records[, options, ...])	The targets of a sweep of the minimum approach temperature, as supertarget returns them.
network_report(HXN[, targets])	Compare the heat exchanger network that a HeatExchangerNetwork facility synthesized with the targets of its process streams: energy, utilities, number of units, area, capital cost and total annualized cost (TAC) of both, side by side.
plot_composite_curves(targets[, kind, ...])	Draw the composite curves of targets: real, shifted, or balanced with the utilities.
plot_grand_composite_curve(targets[, ...])	Draw the grand composite curve of targets with the utility targets as a staircase of levels.
plot_supertargets(sweep[, ax, file, dpi])	Draw the total annualized cost (TAC) of a sweep of the minimum approach temperature, its annualized capital and operating parts, and the least TAC.

• HeatExchangerNetwork
  • HeatExchangerNetwork
  • HeatExchangerNetwork.plot_pinch_diagram()
  • HeatExchangerNetwork.targets()
  • Constructor options
  • Class attributes
  • Attributes set by simulation
• Pinch analysis and synthesis (hensmith.hxn_synthesis)
  • problem_table()
  • ProblemTable
  • synthesize_network()
  • StreamLifeCycle
  • LifeStage
  • StreamSplit
  • plot_pinch_diagram()
• Targeting and supertargeting (hensmith.targeting)
  • PinchTargets
  • PinchTargets.from_heat_utilities()
  • PinchTargets.at()
  • PinchTargets.composite_curves()
  • PinchTargets.grand_composite_curve()
  • PinchTargets.utility_targets()
  • PinchTargets.balanced_composite_curves()
  • PinchTargets.balanced_grand_composite_curve()
  • PinchTargets.area_target()
  • PinchTargets.units_target()
  • PinchTargets.capital_cost_target()
  • PinchTargets.summary()
  • UtilityTarget
  • supertarget()
  • Supertargets
  • Supertargets.to_frame()
  • network_report()
  • plot_composite_curves()
  • plot_grand_composite_curve()
  • plot_supertargets()

Note

Importing hensmith binds the facility into biosteam as bst.HeatExchangerNetwork (and bst.facilities.HeatExchangerNetwork), whichever package is imported first; it is the same class object.