Download data/docs/source/API/api.rst from introvoyz045/hensmith: direct link, hf CLI and curl.
- Browser
- Download file 724 Bytes
-
https://huggingface.co/datasets/introvoyz045/hensmith/resolve/main/data/docs/source/API/api.rst
- Command line
-
hf download hf://datasets/introvoyz045/hensmith/data/docs/source/API/api.rst
-
curl -L -o api.rst https://huggingface.co/datasets/introvoyz045/hensmith/resolve/main/data/docs/source/API/api.rst
724 Bytes
| API Reference | |
| ============= | |
| .. currentmodule:: hensmith | |
| hensmith exports six names. :class:`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. | |
| .. autosummary:: | |
| HeatExchangerNetwork | |
| problem_table | |
| ProblemTable | |
| synthesize_network | |
| StreamLifeCycle | |
| plot_pinch_diagram | |
| .. toctree:: | |
| :maxdepth: 2 | |
| heat_exchanger_network | |
| hxn_synthesis | |
| .. 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. | |