{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "d68b06d5",
   "metadata": {},
   "source": [
    "# List of result methods\n",
    "\n",
    "This list is not complete"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "545f6a1e",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2026-03-24T13:42:35.528408Z",
     "iopub.status.busy": "2026-03-24T13:42:35.527725Z",
     "iopub.status.idle": "2026-03-24T13:42:35.884891Z",
     "shell.execute_reply": "2026-03-24T13:42:35.884170Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'pyltm 0.21.0'"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/html": [
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>what</th>\n",
       "      <th>return_type</th>\n",
       "      <th>name</th>\n",
       "      <th>arguments</th>\n",
       "      <th>description</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>battery</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_energy</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Battery module sum energy</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>battery</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_power_production</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Battery module sum power production</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>busbar</td>\n",
       "      <td>string</td>\n",
       "      <td>build_connection_tree</td>\n",
       "      <td>[]</td>\n",
       "      <td>Create a directed acyclic graph in GraphViz dot format</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>busbar</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_aggregated_hydro_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Returns true if busbar has aggregated hydro results and is not a battery busbar. Result is only valid if the object is part of a model.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>busbar</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_battery_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Returns true if the busbar has battery results</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>busbar</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_detailed_hydro_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Returns true if the busbar has detailed hydro results</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>busbar</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_hydraulic_coupling_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Returns true if there are results from hydraulic couplings type 200 or type 300. Result is only valid if the object is part of a model.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>busbar</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_market_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Returns true if the busbar has market results</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>busbar</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_water_value_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Returns true if the busbar has water value results</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>busbar</td>\n",
       "      <td>list[HydraulicCoupling]</td>\n",
       "      <td>hydraulic_couplings</td>\n",
       "      <td>[]</td>\n",
       "      <td>A list of hydraulic couplings connected to this busbar</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>10</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>market_result_price</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Busbar market results over time</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>11</th>\n",
       "      <td>busbar</td>\n",
       "      <td>list[Reservoir]</td>\n",
       "      <td>reservoirs</td>\n",
       "      <td>[]</td>\n",
       "      <td>A list of reservoirs (with plants) connected to this busbar</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>12</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_hydro_production</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Busbar sum hydro production steps over time</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>13</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_load</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Busbar sum load filling over time</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>14</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_power_used_for_pumping</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Aggregated sum of power used to pump in the busbar</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>15</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_production_from_market_steps</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Busbar sum production from market steps over time</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>16</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_pumped_power</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Aggregated sum of power stored with pumping</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>17</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_reservoir</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Busbar sum reservoir filling over time</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>18</th>\n",
       "      <td>busbar</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>water_value_results</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Water values for busbar</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>19</th>\n",
       "      <td>cne</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>get_dual_values</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>FBMC dual values. Results are only valid with model type EMPS.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>20</th>\n",
       "      <td>cne</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>get_flow_values</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>FBMC flow values. Results are only valid with model type EMPS.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>21</th>\n",
       "      <td>dcline</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_transmission_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Returns true if there are valid transmission results for this DCLine</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>22</th>\n",
       "      <td>dcline</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>transmission_results</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Transmission results for DCLine</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>23</th>\n",
       "      <td>enmag</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_hydro_energy</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Aggregated hydro module sum hydro energy</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24</th>\n",
       "      <td>enmag</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>sum_hydro_power_production</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Aggregated hydro module sum hydro power production</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>25</th>\n",
       "      <td>hydraulic_coupling</td>\n",
       "      <td>list[Reservoir]</td>\n",
       "      <td>connected_reservoirs</td>\n",
       "      <td>[]</td>\n",
       "      <td>For a non-station joined hydraulic coupling (type 200 or 300), returns connected reservoirs.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>26</th>\n",
       "      <td>hydraulic_coupling</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>discharge</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Hydraulic coupling discharge. Only relevant if HC is connected to a plant.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>27</th>\n",
       "      <td>hydraulic_coupling</td>\n",
       "      <td>bool</td>\n",
       "      <td>have_hydraulic_flow_results</td>\n",
       "      <td>[]</td>\n",
       "      <td>Are there hydraulic flow results available for this hydraulic coupling. Only available in EOPS, and with a license enabling hydraulic flow results.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>28</th>\n",
       "      <td>hydraulic_coupling</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>production</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Hydraulic coupling production. Only relevant if HC is connected to a plant.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>29</th>\n",
       "      <td>reservoir</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>bypass</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Reservoir bypass over time (price segment resolution).</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>30</th>\n",
       "      <td>reservoir</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>discharge</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Reservoir discharge over time (price segment resolution).</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>31</th>\n",
       "      <td>reservoir</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>flow</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Flow exchange results for hydraulic coupling. Only available with EOPS, and a license enabling flow exchange results.</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>32</th>\n",
       "      <td>reservoir</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>inflow</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Reservoir inflow over time (price segment resolution).</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>33</th>\n",
       "      <td>reservoir</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>production</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Reservoir/plant production over time (price segment resolution).</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>34</th>\n",
       "      <td>reservoir</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>reservoir</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Reservoir filling over time (price segment resolution).</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>35</th>\n",
       "      <td>reservoir</td>\n",
       "      <td>PyltmResult</td>\n",
       "      <td>spill</td>\n",
       "      <td>[time_axis = true # Time axis included in results.]</td>\n",
       "      <td>Reservoir spill over time (price segment resolution).</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>"
      ],
      "text/plain": [
       "<IPython.core.display.HTML object>"
      ]
     },
     "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_result_methods():\n",
    "    result_methods = pyltm.LtmApiModule.results()\n",
    "    frame = pd.DataFrame(result_methods)\n",
    "    display(HTML(frame.to_html()))\n",
    "\n",
    " \n",
    "display(f\"pyltm {version(\"pyltm\")}\")\n",
    "\n",
    "show_ltmapi_result_methods()"
   ]
  }
 ],
 "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": 5
}