{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# List of API attributes" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "**The attributes in this list are subject to change without notice.**\n", "\n", "Conventions used in the desgin of the API and attributes:\n", "\n", "For energy:\n", "\n", "* Use `MW` wherever possible.\n", "* `MWh` when `MW` does not make sense.\n", "\n", "For water flow:\n", "\n", "* Use `m3/sec` wherever possible.\n", "* Use `Mm3` when `m3/sec` does not make sense." ] }, { "cell_type": "code", "execution_count": 1, "metadata": { "execution": { "iopub.execute_input": "2026-03-24T13:42:37.044978Z", "iopub.status.busy": "2026-03-24T13:42:37.044347Z", "iopub.status.idle": "2026-03-24T13:42:37.377134Z", "shell.execute_reply": "2026-03-24T13:42:37.374995Z" } }, "outputs": [ { "data": { "text/plain": [ "'pyltm 0.21.0'" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "text/html": [ "\n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", "
collectionwhattype_namenametypeunitdefault_valuedescriptionrequired
0batteriesbatteryBatteryModule#commentstringUser commentFalse
1batteriesbatteryBatteryModulenamestringObject nameTrue
2batteriesbatteryBatteryModulemetadatajsonUser metadataFalse
3batteriesbatteryBatteryModulebusbar_namestringBusbar nameFalse
4batteriesbatteryBatteryModulestart_battery_energydoubleMWh0.00Initial battery energy.True
5batteriesbatteryBatteryModuleendvalue_typeint0Endvalue typeFalse
6batteriesbatteryBatteryModulemax_energy_leveltxyMWhMax energy levelTrue
7batteriesbatteryBatteryModulemin_energy_leveltxyMWhMin energy levelTrue
8batteriesbatteryBatteryModulemax_discharge_powertxyMWMax discharge powerTrue
9batteriesbatteryBatteryModulemin_discharge_powertxyMWMin discharge powerTrue
10batteriesbatteryBatteryModulecharging_efficiencytxyFactorCharging efficiencyTrue
11batteriesbatteryBatteryModulemax_charging_powertxyMWMax charging powerTrue
12batteriesbatteryBatteryModulecharging_costtxyCurrencyCharging costTrue
13batteriesbatteryBatteryModuleexogenous_endvaluetxyCurrency / energy unitExogenous endvalueFalse
14bidding_zonesbidding_zoneBiddingZone#commentstringUser commentFalse
15bidding_zonesbidding_zoneBiddingZonenamestringObject nameTrue
16bidding_zonesbidding_zoneBiddingZonemetadatajsonUser metadataFalse
17bidding_zonesbidding_zoneBiddingZoneis_fbmcboolYes/No1Is bidding zone a part of the FBMC networkFalse
18busbarsbusbarBusbar#commentstringUser commentFalse
19busbarsbusbarBusbarnamestringObject nameTrue
20busbarsbusbarBusbarmetadatajsonUser metadataFalse
21busbarsbusbarBusbaridint0Internal IDFalse
22busbarsbusbarBusbarwater_value_weightswater_value_optionalWater value weightsFalse
23busbarsbusbarBusbarspill_costdouble_optionalSpill cost priceFalse
24busbarsbusbarBusbarload_penaltydouble_optionalLoad penalty priceFalse
25busbarsbusbarBusbarmax_iterationsint_optionalMax number of iterations for this busbarFalse
26busbarsbusbarBusbarprecisiondouble_optionalPrecision for this busbarFalse
27busbarsbusbarBusbarfeedback_factorsfeedback_factors_optionalBusbar feedback factorsFalse
28busbarsbusbarBusbarhas_detailed_gridbool0Participates in detailed grid or notFalse
29bypassesbypassBypass#commentstringUser commentFalse
30bypassesbypassBypassnamestringObject nameTrue
31bypassesbypassBypassmetadatajsonUser metadataFalse
32bypassesbypassBypassmin_bypass_curvetxylinm3/secMin bypass curveFalse
33bypassesbypassBypassmin_bypass_series_namestringstringMin bypass series nameFalse
34bypassesbypassBypassmin_bypass_scaledoublefactor0.00Min bypass scaling factorFalse
35bypassesbypassBypassmax_bypass_curvetxylinm3/secMax bypass curveFalse
36bypassesbypassBypassmax_bypass_series_namestringstringMax bypass series nameFalse
37bypassesbypassBypassmax_bypass_scaledoublefactor0.00Max bypass scaling factorFalse
38cnescneCriticalNetworkElement#commentstringUser commentFalse
39cnescneCriticalNetworkElementnamestringObject nameTrue
40cnescneCriticalNetworkElementmetadatajsonUser metadataFalse
41cnescneCriticalNetworkElementactivetxytime/on/offActive timeseriesTrue
42cnescneCriticalNetworkElementramtxyMWRemaining available capacityTrue
43cnescneCriticalNetworkElementptdfmap_txyPower Transfer Distribution FactorTrue
44dclinesdclineDCLine#commentstringUser commentFalse
45dclinesdclineDCLinenamestringObject nameTrue
46dclinesdclineDCLinemetadatajsonUser metadataFalse
47dclinesdclineDCLineforward_capacitytxyDefines the capacity from busbar A to busbar BTrue
48dclinesdclineDCLinebackward_capacitytxyDefines the capacity from busbar B to busbar ATrue
49dclinesdclineDCLineloss_percentagedouble0.00Loss percentageFalse
50dclinesdclineDCLineforward_costdouble0.00Forward costFalse
51dclinesdclineDCLinebackward_costdouble0.00Backward costFalse
52dclinesdclineDCLinefrom_busbarstringFrom busbarFalse
53dclinesdclineDCLineto_busbarstringTo busbarFalse
54dclinesdclineDCLineidint0Internal IDFalse
55aggregated_hydro_modulesenmagAggregatedHydroModule#commentstringUser commentFalse
56aggregated_hydro_modulesenmagAggregatedHydroModulenamestringObject nameTrue
57aggregated_hydro_modulesenmagAggregatedHydroModulemetadatajsonUser metadataFalse
58aggregated_hydro_modulesenmagAggregatedHydroModulebusbar_namestringBusbar nameFalse
59aggregated_hydro_modulesenmagAggregatedHydroModulereservoir_energydouble0.00Total reservoir energy. Unit: MWh.True
60aggregated_hydro_modulesenmagAggregatedHydroModulestation_powerdouble0.00Max station production. Unit: MW.True
61aggregated_hydro_modulesenmagAggregatedHydroModuleregulated_power_inflowtxyMWRegulated power inflowTrue
62aggregated_hydro_modulesenmagAggregatedHydroModuleunregulated_power_inflowtxyMWUnregulated power inflowTrue
63aggregated_hydro_modulesenmagAggregatedHydroModuleupper_reservoir_limitstxy_optionalMWhUpper reservoir limitsFalse
64aggregated_hydro_modulesenmagAggregatedHydroModulelower_reservoir_limitstxy_optionalMWhLower reservoir limitsFalse
65aggregated_hydro_modulesenmagAggregatedHydroModuleupper_production_limitstxy_optionalMWUpper production limitsFalse
66aggregated_hydro_modulesenmagAggregatedHydroModulelower_production_limitstxy_optionalMWLower production limitsFalse
67aggregated_hydro_modulesenmagAggregatedHydroModulestart_reservoir_energydoubleMWh0.00Initial aggregated reservoir energyTrue
68global_settingsGlobalSettings#commentstringUser commentFalse
69global_settingsGlobalSettingsnamestringObject nameTrue
70global_settingsGlobalSettingsmetadatajsonUser metadataFalse
71global_settingsGlobalSettingsoutput_pathstringOutput and runtime directory where LTM will read and write dataTrue
72global_settingsGlobalSettingssimulation_periodtxyEMPS/EOPS simulation period. Previously calc_water_value_flag.True
73global_settingsGlobalSettingswater_value_periodtxy_optionalWater value periodFalse
74global_settingsGlobalSettingsdata_periodtxy_optionalData periodFalse
75global_settingsGlobalSettingshistorical_periodtxyHistorical periodTrue
76global_settingsGlobalSettingsforecast_periodtxy_optionalForecast periodFalse
77global_settingsGlobalSettingsintraweek_timestepstxy_optionalFormer 'simulation_price_period' / price segmentsFalse
78global_settingsGlobalSettingstimesteps_per_weekint_optionalAutomatic, sequential time steps / price segmentsFalse
79global_settingsGlobalSettingsmax_iterationsint40Default max iterationsFalse
80global_settingsGlobalSettingsprecisiondouble0.00Default precisionFalse
81global_settingsGlobalSettingsdefault_max_iterations_batteryint_optionalDefault max iterations for battery areas (busbars)False
82global_settingsGlobalSettingsdefault_precision_batterydouble_optionalDefault precision for batteriesFalse
83global_settingsGlobalSettingsdefault_spill_costdouble0.01Default spill cost. Usually non-zero, but very close to zero.False
84global_settingsGlobalSettingsdefault_load_penaltydouble3000.00Default load penalty. Must be higher than the highest price in any other market step.False
85global_settingsGlobalSettingsethadouble1.00ETHATrue
86global_settingsGlobalSettingsgenerate_output_dirbool1Generate a runtime subfolder under output_pathFalse
87global_settingsGlobalSettingsdelete_output_dirbool1Delete runtime directory after executionFalse
88global_settingsGlobalSettingsignore_stopwordsbool0Continue execution even if there are possible errors in EMPS/EOPS logsFalse
89global_settingsGlobalSettingscalendar_modecalendar_modeCalendar modeFalse
90global_settingsGlobalSettingsallow_validation_failuresbool0Ignore validation failuresFalse
91global_settingsGlobalSettingsexport_targetexport_targetFalse
92global_settingsGlobalSettingsexport_directory_pathstringFalse
93global_settingsGlobalSettingsexport_settingsexport_settingsFalse
94global_settingsGlobalSettingssimulation_typesimulation_typeParallel or serial simulationFalse
95global_settingsGlobalSettingsmodel_typemodel_typeEMPS or EOPS modelFalse
96global_settingsGlobalSettingshistorical_typehistorical_typeHistorical period calendar typeFalse
97global_settingsGlobalSettingsnum_price_scenariosint1False
98global_settingsGlobalSettingsltm_license_file_pathstring_optionalPath to LTM license fileFalse
99global_settingsGlobalSettingsinterest_ratedouble_optionalGlobal interest rateFalse
100global_settingsGlobalSettingsfbmcbool_optionalFlow-Based Market-CouplingFalse
101global_settingsGlobalSettingsfbmc_periodtxy_optionalFBMC active periodFalse
102global_settingsGlobalSettingsjao_data_sourcestringJAO data source (file) with PTDF dataFalse
103global_settingsGlobalSettingskronasjerstringEURDefault currency unitFalse
104global_settingsGlobalSettingscurrency_unitstringEURDefault currency unitFalse
105global_settingsGlobalSettingsenergy_unitstringMWhDefault energy unitFalse
106global_settingsGlobalSettingsnum_processesint1Number of paralell MPI processessFalse
107global_settingsGlobalSettingsextra_environmentdict_typeExpert use only. Additional environment variables to set when executing LTM applications.False
108hydraulic_couplingshydraulic_couplingHydraulicCoupling#commentstringUser commentFalse
109hydraulic_couplingshydraulic_couplingHydraulicCouplingnamestringObject nameTrue
110hydraulic_couplingshydraulic_couplingHydraulicCouplingmetadatajsonUser metadataFalse
111hydraulic_couplingshydraulic_couplingHydraulicCouplingbusbar_namestringBusbar nameFalse
112hydraulic_couplingshydraulic_couplingHydraulicCouplinggate_switch_frequencyint_optionalunit-lessGate/hatch switch frequency. 0-100. 0 and 100 = no limits, 50 = most limited. Numbers 0-49, 51-100 determines what side of the hatch/gate to prefer.False
113hydraulic_couplingshydraulic_couplingHydraulicCouplingmax_flowint_optionalm3/secMax flow through the coupling, note the unit is an integerFalse
114hydraulic_couplingshydraulic_couplingHydraulicCouplingstation_joinedboolbool0Is connected to a plant/station. ReadonlyFalse
115inflow_seriesinflowInflow#commentstringUser commentFalse
116inflow_seriesinflowInflownamestringObject nameTrue
117inflow_seriesinflowInflowmetadatajsonUser metadataFalse
118inflow_seriesinflowInflowseriestxym^3/sInflow seriesTrue
119inflow_seriesinflowInflowforecasttxy_optionalm^3/sOptional forecast seriesFalse
120inflow_seriesinflowInflowforecast_periodtxy_optionalOptional forecast periodFalse
121loadsloadLoad#commentstringUser commentFalse
122loadsloadLoadnamestringObject nameTrue
123loadsloadLoadmetadatajsonUser metadataFalse
124loadsloadLoadbusbar_namestringBusbar nameFalse
125loadsloadLoadcapacitytxyMWLoad capacityTrue
126market_calibration_areasmarket_calibration_areaMarketCalibrationArea#commentstringUser commentFalse
127market_calibration_areasmarket_calibration_areaMarketCalibrationAreanamestringObject nameTrue
128market_calibration_areasmarket_calibration_areaMarketCalibrationAreametadatajsonUser metadataFalse
129market_stepsmarket_stepMarketStep#commentstringUser commentFalse
130market_stepsmarket_stepMarketStepnamestringObject nameTrue
131market_stepsmarket_stepMarketStepmetadatajsonUser metadataFalse
132market_stepsmarket_stepMarketStepbusbar_namestringBusbar nameFalse
133market_stepsmarket_stepMarketStepcatint0Category for market stepFalse
134market_stepsmarket_stepMarketStepcapacitytxyCapacity time seriesTrue
135market_stepsmarket_stepMarketStepcapacity_vvtxy_optionalCapacity time series used for the water value calculationFalse
136market_stepsmarket_stepMarketSteppricetxy_optionalPrice time seriesFalse
137market_stepsmarket_stepMarketStepexogenous_pricetxy_optionalExogenous price time seriesFalse
138market_stepsmarket_stepMarketStepsecondary_price_series_namestringName of connected seconday price seriesFalse
139plantsplantPlant#commentstringUser commentFalse
140plantsplantPlantnamestringObject nameTrue
141plantsplantPlantmetadatajsonUser metadataFalse
142plantsplantPlantbusbar_namestringBusbar nameFalse
143plantsplantPlantownershipdouble%100.00Ownership of this module. In percentFalse
144plantsplantPlantdischarge_energy_equivalenttxykWh/m^3Local discharge energy equivalent time series, given together with turbine PQ-curves. The time period must be aligned with pq_curves. If using a repeating PQ-curve, discharge energy equivalent must be within the same range. If unsure, use `W01`True
145plantsplantPlantpq_curvesxytTime + X=m^3/sec Y=MWPQ efficiency curves. Must be used with discharge energy equivalent. Timestamps must also be in the same period as discharge energy equivalent.True
146plantsplantPlantunregulated_inflowtxym^3/secUnregulated inflow time seriesFalse
147plantsplantPlantunregulated_inflow_namestringInflow series nameFalse
148plantsplantPlantaverage_unregulated_inflowdoublem^3/s0.00Average yearly unregulated inflow.True
149plantsplantPlantgross_headdoublem0.00Nominal gross head (brutto fallhoyde)True
150plantsplantPlanttailrace_elevationdoublem0.00Plant tailrace elevation (utlopskote stasjon)True
151plantsplantPlantmax_discharge_curvetxylinm3/secMax discharge curveFalse
152plantsplantPlantmax_discharge_series_namestringstringSeries name for max discharge series in historical.h5False
153plantsplantPlantmax_discharge_scaledoublefactor0.00Scale factor of the input series. Only used for series from historical.h5False
154plantsplantPlantmin_discharge_curvetxylinm3/secMin discharge curveFalse
155plantsplantPlantmin_discharge_series_namestringstringMin discharge series name in historical.h5False
156plantsplantPlantmin_discharge_scaledoublefactor0.00Min discharge scaling factor. Only used for series from historical.h5False
157plantsplantPlantmin_bypass_curvetxylinm3/secMin bypass curveFalse
158plantsplantPlantmin_bypass_series_namestringstringMin bypass series name in historical.h5False
159plantsplantPlantmin_bypass_scaledoublefactor0.00Min bypass scaling factor. Only used for series from historical.h5False
160plantsplantPlantgross_head_max_dischargexym3/s - mMaximum discharge as function of gross headFalse
161plantsplantPlantmax_bypass_curvetxylinm3/secMax bypass curveFalse
162plantsplantPlantmax_bypass_series_namestringstringMax bypass series name in historical.h5False
163plantsplantPlantmax_bypass_scaledoublefactor0.00Max bypass scaling factor. Only used for series from historical.h5False
164plantsplantPlanttailrace_elevationdoublem0.00Plant tailrace elevation (utlopskote stasjon)True
165plantsplantPlantunavailable_capacitytxyMWPlanned capacity outage for a plant (revision)False
166plantsplantPlantbreakdown_unavailable_capacitytxyMWUnforeseen downtimes capacity outage for a plant (havari)False
167price_series_mainprice_series_mainMainPriceSeries#commentstringUser commentFalse
168price_series_mainprice_series_mainMainPriceSeriesnamestringObject nameTrue
169price_series_mainprice_series_mainMainPriceSeriesmetadatajsonUser metadataFalse
170price_series_mainprice_series_mainMainPriceSeriesseriestxyUnknownPrice series valuesTrue
171price_series_mainprice_series_mainMainPriceSeriesprobabilitiesdouble_vector_optionalOption to customise probabilities of the price scenarios. Overrides default: price scenarios has equal probability.False
172price_series_mainprice_series_mainMainPriceSeriespercentiles_for_water_valuesdouble_vectorCustomize percentiles for the price levels. Adds a price scenario dimension to water values.False
173price_series_secondaryprice_series_secondarySecondaryPriceSeries#commentstringUser commentFalse
174price_series_secondaryprice_series_secondarySecondaryPriceSeriesnamestringObject nameTrue
175price_series_secondaryprice_series_secondarySecondaryPriceSeriesmetadatajsonUser metadataFalse
176price_series_secondaryprice_series_secondarySecondaryPriceSeriesseriestxyUnknownPrice series values1. Given as a flattened Txy of  1931_1, 1931_2, 1932_1, ...True
177price_series_secondaryprice_series_secondarySecondaryPriceSeriesprobabilitiesdouble_vector_optionalOption to customise probabilities of the price scenarios. Use to override the default where each price scenario receives equal probability.False
178pumpspumpPump#commentstringUser commentFalse
179pumpspumpPumpnamestringObject nameTrue
180pumpspumpPumpmetadatajsonUser metadataFalse
181pumpspumpPumpbusbar_namestringBusbar nameFalse
182pumpspumpPumpownershipdouble%0.00Pump ownership shareTrue
183pumpspumpPumpaverage_powerdoubleMW0.00Average pump powerTrue
184pumpspumpPumppump_capacityxymeter, m3/secPump capacity, pump height / flowTrue
185pumpspumpPumpupper_reservoir_reference_curvetxylintimestamp, Mm3Upper reservoir reference curve. Pump will stop pumping if upper reservoir goes over this limit.True
186pumpspumpPumplower_reservoir_reference_curvetxylintimestamp, Mm3Lower reservoir reference curve. Pump will stop pumping if lower reservoir goes under this limit.True
187pumpspumpPumpunavailable_capacitytxyMWPlanned capacity outage for a pump (revision)False
188pumpspumpPumpbreakdown_unavailable_capacitytxyMWUnforeseen downtimes capacity outage for a pump (havari)False
189reservoirsreservoirReservoir#commentstringUser commentFalse
190reservoirsreservoirReservoirnamestringObject nameTrue
191reservoirsreservoirReservoirmetadatajsonUser metadataFalse
192reservoirsreservoirReservoirbusbar_namestringBusbar nameFalse
193reservoirsreservoirReservoirmodule_numberint0Automatically generated DETD module number. Used by LTM to build relations between modules.True
194reservoirsreservoirReservoirmax_volumedoubleMillion m^30.00Maximum volume of this reservoirFalse
195reservoirsreservoirReservoirdegree_of_regulationdoublefactor0.00Reservoir regulation capacity (reguleringsgrad)False
196reservoirsreservoirReservoiraverage_spill_energy_equivalentdoublekWh/m30.00Average energy equivalent for spills.True
197reservoirsreservoirReservoirreservoir_typereservoir_typeRegulation or buffer reservoirFalse
198reservoirsreservoirReservoirregulated_inflowtxym^3/secRegulated inflow time seriesFalse
199reservoirsreservoirReservoirregulated_inflow_namestringInflow series nameFalse
200reservoirsreservoirReservoiraverage_regulated_inflowdoublem^3/s0.00Average yearly regulated inflow.True
201reservoirsreservoirReservoirmax_dischargedoublem^3/sec0.00Maximum production dischargeTrue
202reservoirsreservoirReservoirreference_curvetxylinMillion m^3Reservoir reference curveTrue
203reservoirsreservoirReservoirvolume_curvexymeter / million m^3Reservoir volume curveFalse
204reservoirsreservoirReservoirinitial_volumedoubleMm30.00Reservoir initial volume.False
205reservoirsreservoirReservoirgross_headdoublem0.00Nominal gross head (brutto fallhoyde)False
206reservoirsreservoirReservoirtailrace_elevationdoublem0.00Reservoir tailrace elevation (utlopskote)False
207reservoirsreservoirReservoirmax_volume_curvetxylinMm3Restriction 1, reservoir max volumeFalse
208reservoirsreservoirReservoirmax_volume_curve_hard_limitintbool0Restriction 1, reservoir has max volume hard limitFalse
209reservoirsreservoirReservoirmin_volume_curvetxylinMm3Restriction 2, reservoir min volumeFalse
210reservoirsreservoirReservoirmin_volume_curve_hard_limitintbool0Restriction 2, reservoir has min volume hard limitFalse
211reservoirsreservoirReservoirmax_discharge_curvetxylinm3/secMax discharge curveFalse
212reservoirsreservoirReservoirmax_discharge_series_namestringstringSeries name for max discharge seriesFalse
213reservoirsreservoirReservoirmax_discharge_scaledoublefactor0.00Scale factor of the input seriesFalse
214reservoirsreservoirReservoirmin_discharge_curvetxylinm3/secMin discharge curveFalse
215reservoirsreservoirReservoirmin_discharge_series_namestringstringMin discharge series nameFalse
216reservoirsreservoirReservoirmin_discharge_scaledoublefactor0.00Min discharge scaling factorFalse
217reservoirsreservoirReservoirmin_bypass_curvetxylinm3/secMin bypass curveFalse
218reservoirsreservoirReservoirmin_bypass_series_namestringstringMin bypass series nameFalse
219reservoirsreservoirReservoirmin_bypass_scaledoublefactor0.00Min bypass scaling factorFalse
220reservoirsreservoirReservoirmax_bypass_curvetxylinm3/secMax bypass curve\\n\\nTime dependent curve for maximum allowed bypassFalse
221reservoirsreservoirReservoirmax_bypass_series_namestringstringMax bypass series nameFalse
222reservoirsreservoirReservoirmax_bypass_scaledoublefactor0.00Max bypass scaling factorFalse
223reservoirsreservoirReservoirhc_max_flowint_optionalHydraulic coupling max flow\\n\\nOverride max_flow in a hydraulic system per moduleFalse
224reservoirsreservoirReservoirhc_has_gateint_optionalHydraulic coupling has gate\\n\\nOverride has_gate in a hydraulic system per moduleFalse
225solarsolarSolar#commentstringUser commentFalse
226solarsolarSolarnamestringObject nameTrue
227solarsolarSolarmetadatajsonUser metadataFalse
228solarsolarSolarbusbar_namestringBusbar nameFalse
229solarsolarSolarcapacitytxyMWSolar powerTrue
230spillsspillSpill#commentstringUser commentFalse
231spillsspillSpillnamestringObject nameTrue
232spillsspillSpillmetadatajsonUser metadataFalse
233watercourseswatercourseWatercourse#commentstringUser commentFalse
234watercourseswatercourseWatercoursenamestringObject nameTrue
235watercourseswatercourseWatercoursemetadatajsonUser metadataFalse
236watercourseswatercourseWatercoursebusbar_namestringBusbar nameFalse
237windwindWind#commentstringUser commentFalse
238windwindWindnamestringObject nameTrue
239windwindWindmetadatajsonUser metadataFalse
240windwindWindbusbar_namestringBusbar nameFalse
241windwindWindcapacitytxyMWWind powerTrue
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "# Print attributes\n", "from IPython.display import HTML, display\n", "import pyltm\n", "import pandas as pd\n", "from importlib.metadata import version\n", "\n", "def show_ltmapi_attributes():\n", " attributes = pyltm.LtmApiModule.attributes()\n", " frame = pd.DataFrame(attributes)\n", " display(HTML(frame.to_html()))\n", "\n", "display(f\"pyltm {version(\"pyltm\")}\")\n", "\n", "show_ltmapi_attributes()" ] } ], "metadata": { "kernelspec": { "display_name": "ltmio-3.14", "language": "python", "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.13.12" } }, "nbformat": 4, "nbformat_minor": 2 }