.. _model:

=====
Model
=====

.. cssclass:: sphinx-tagline
.. epigraph:: Run and experiment with complex models with ease

The model is the complete set of data required to run a simulation.
The different types of data is detailed in the list below.

Getting started
===============

   Basic installation instructions and create venv.

   .. toctree::
      :maxdepth: 1

      guides/getting_started
      Minimal usage example <guides/live-ltm/live-ltm.ipynb>
      guides/import_directory/import_directory

LtmApi introductions with examples
==================================

   Introductary material for using the LtmApi.

   .. toctree::
      :maxdepth: 1
      :glob:

      guides/time_LtmApi
      guides/break_point_series
      guides/piecewise_linear_constraints
      guides/water_ways
      guides/residual_load/residual_loads.rst
      guides/couplings/hydraulic-couplings
      guides/forecast/forecast
      guides/pumps/pumps_example
      guides/batteries/batteries_example
      guides/fbmc/fbmc_example
      guides/eops/eops_example
      guides/exogeneous_prices_market_step/exogenous_prices_market_step
      guides/exogeneous_prices_water_value/exogeneous_prices_water_value

   Notebooks

   .. toctree::
      :maxdepth: 1
      :glob:

      guides/ltmapi_attributes.ipynb
      guides/ltmapi_result_methods.ipynb
      guides/couplings/hydr-couplings-notebook.ipynb
      guides/emps_serial/emps_serial_simulation.ipynb
      guides/cyclic-curves/cyclic-curves.ipynb

Datatypes
=========

   .. toctree::
      :maxdepth: 1
      :glob:

      data/*

Objects
=======

Discriptions of the most commonly use object in the LtmApi.

   .. toctree::
      :maxdepth: 1
      :glob:

      objects/global_settings.rst
      objects/Api_hydropower.rst
      objects/dc_lines.rst
      objects/loads.rst
      objects/market_calibration_area.rst
      objects/price_series.rst
      objects/pumps.rst
      objects/wind_and_solar.rst
      objects/util_objects.rst

Notebooks
=========

   Collection of notebooks for various concepts and features not covered elsewhere.

   .. toctree::
      :maxdepth: 1
      :glob:

      guides/revisjonsplan_stas/revisjonsplan_stas.ipynb

Other
=====

   .. toctree::
      :maxdepth: 1
      :glob:

      other/license.rst
      other/logging.rst
      execution/*