===============
LTM and LTM-API
===============

This is the combined documentation of LTM (EMPS/EOPS) and LTM-API.

.. figure:: ltm-vs-ltmapi.png
   :scale: 50%
   :alt: User experience comparing LTM vs LTM-API

   End user experience comparing LTM (EMPS/EOPS) with LTM-API.

Motivating example
==================

In a couple of lines of code it is possible to add or remove areas, add dclines, assign loads, capacities and much more.

.. code-block:: python

   # Add busbars (areas)
   numedal = session.model.add("busbar", "numedal")
   tev = session.model.add("busbar", "tev")

   # Add DC-line
   dc = session.model.add("dcline", "dc_numedal_tev")

   # Connect DC between areas
   session.connect(numedal, dc)
   session.connect(dc, tev)

This, and much more is possible with LTM-API.

The notebook `Live LTM contains a minimal example`_.

.. _Live LTM contains a minimal example: ltm-api/guides/live-ltm/live-ltm.ipynb

Contents
========

.. toctree::
   :maxdepth: 3

   Overview <readme>
   LTM Core <ltm-core/ltm-core>
   LTM API <ltm-api/model>

   pyltmapi reference <api/modules>
   pyltm reference <pyltm_rst/modules>

   License <license>
   Authors <authors>
   Contributing <contributing>
   Changelog <changelog>
   Backlog <backlog>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _toctree: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _references: https://www.sphinx-doc.org/en/stable/markup/inline.html
.. _Python domain syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain
.. _Sphinx: https://www.sphinx-doc.org/
.. _Python: https://docs.python.org/
.. _Numpy: https://numpy.org/doc/stable
.. _SciPy: https://docs.scipy.org/doc/scipy/reference/
.. _matplotlib: https://matplotlib.org/contents.html#
.. _Pandas: https://pandas.pydata.org/pandas-docs/stable
.. _Scikit-Learn: https://scikit-learn.org/stable
.. _autodoc: https://www.sphinx-doc.org/en/master/ext/autodoc.html
.. _Google style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
.. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
.. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists