{ "cells": [ { "cell_type": "markdown", "id": "b9ed5ff5", "metadata": {}, "source": [ "(pump)=\n", "# pump\n", "A pump from one module to another.\n", "\n", "| | |\n", "|---|---|\n", "|Input connections||\n", "|Output connections||\n", "|License|PRODRISK_OPEN|\n", "|Release version|9.6.1|\n", "\n", "```{contents}\n", ":local:\n", ":depth: 1\n", "```\n", "\n", "\n", "\n", "\n", "\n", "\n", "\n", "## Attributes" ] }, { "cell_type": "code", "execution_count": 1, "id": "646b1876", "metadata": { "tags": [ "remove-input", "full-width" ] }, "outputs": [ { "data": { "text/html": [ "\n" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "text/html": [ "\n", "\n", "\n", "\n", "\n", "\n", "
Object typeAttribute namePython data typeCore data typeunitI/OLicenseVersion addedDescription
\n", "\n", "
\n", "Loading ITables v2.1.4 from the internet...\n", "(need help?)
\n", "\n", "\n" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "text/html": [ "" ], "text/plain": [ "" ] }, "execution_count": 1, "metadata": {}, "output_type": "execute_result" } ], "source": [ "import itables as itables\n", "from itables import init_notebook_mode\n", "init_notebook_mode(all_interactive=True, connected=True)\n", "import pandas as pd\n", "from IPython.core.display import HTML\n", "\n", "table = pd.read_csv('../../../attributes.csv')\n", "core_type_dict = {'int' : 'integer','double':'float','string':'string','int_array':'list-of-integer-values','double_array':'list-of-double-values','xy':'table-xy-curve','xy_array':'list-of-tables','txy':'time-series','txy_stochastic':'stochastic-time-series'}\n", "object_attributes = table[table[\"Object type\"] == \"pump\"].reset_index().iloc[:, 1:]\n", "for index, row in object_attributes.iterrows():\n", " object_attributes.at[index, \"Attribute name\"] = f\"\"\"{row['Attribute name']}\"\"\"\n", " object_attributes.at[index, \"Core data type\"] = f\"\"\"{row['Core data type']}\"\"\"\n", "itables.show(object_attributes,\n", " dom='tlip',\n", " search={'regex': True, \"caseInsensitive\": True},\n", " column_filters='header',\n", " columns=[\n", " {\n", " 'name': '',\n", " 'className': 'dt-control',\n", " 'orderable': False,\n", " 'data': None,\n", " 'defaultContent': '',\n", " },\n", " {\n", " 'name': 'Attribute name',\n", " 'className': 'dt-body-left'\n", " },\n", " {\n", " 'name': 'Python data type',\n", " 'className': 'dt-body-left'\n", " },\n", " {\n", " 'name': 'Core data type',\n", " 'className': 'dt-body-left'\n", " },\n", " {\n", " 'name': 'unit',\n", " 'className': 'dt-body-left'\n", " },\n", " {\n", " 'name': 'I/O',\n", " 'className': 'dt-body-left'\n", " },\n", " {\n", " 'name': 'License',\n", " 'className': 'dt-body-left'\n", " },\n", " {\n", " 'name': 'Version added',\n", " 'className': 'dt-body-left'\n", " },\n", " {\n", " 'name': 'Description',\n", " 'visible': False\n", " }\n", " ]\n", ")\n", "HTML('''''')" ] }, { "cell_type": "markdown", "id": "ae507a23", "metadata": {}, "source": [ "(pump:name)=\n", "### name\n", "Pump name, written to internal file model.h5. Not used for anything else. (unit: none)\n", "\n", "\n", "(pump:intakeRsvCurve)=\n", "### intakeRsvCurve\n", "Do not pump if downstream reservoir volume is below this limit. (unit: Mm3)\n", "\n", "\n", "(pump:maxPumpHeight)=\n", "### maxPumpHeight\n", "Largest pumping height (unit: m)\n", "\n", "\n", "(pump:minPumpHeight)=\n", "### minPumpHeight\n", "Smallest pumping height (unit: m)\n", "\n", "\n", "(pump:averagePower)=\n", "### averagePower\n", "Average consumption when pump is used (unit: MW)\n", "\n", "\n", "(pump:maintenance)=\n", "### maintenance\n", "Capacity unavailable due to pump maintenance. This attribute is not required input and may be left out if no maintenance is scheduled (unit: MW)\n", "\n", "\n", "(pump:maxHeightUpflow)=\n", "### maxHeightUpflow\n", "Pump upflow at largest pumping height (unit: m3/s)\n", "\n", "\n", "(pump:ownerShare)=\n", "### ownerShare\n", "Fraction owned of the pump, used to scale average consumption. Must be in [0,1]. (unit: none)\n", "\n", "\n", "(pump:topology)=\n", "### topology\n", "Toplogy description for pumps (external module numbers for): [module containing the pump, module where water is pumped to, module where water is pumped from]. (unit: none)\n", "\n", "\n", "(pump:outletRsvCurve)=\n", "### outletRsvCurve\n", "Do not pump if upstream reservoir volume is above this limit. (unit: Mm3)\n", "\n", "\n", "(pump:minHeightUpflow)=\n", "### minHeightUpflow\n", "Pump upflow at smallest pumping height (unit: m3/s)" ] } ], "metadata": { "jupytext": { "text_representation": { "extension": ".md", "format_name": "myst", "format_version": 0.13, "jupytext_version": "1.13.8" } }, "kernelspec": { "display_name": "Python 3", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.11.9" }, "source_map": [ 11, 36, 114 ] }, "nbformat": 4, "nbformat_minor": 5 }