.. _getting-started:

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

Required software
=================

User supplied software
----------------------

* 64-bit Linux or Windows
* Python 3.12 or above
* Git

SINTEF supplied software
------------------------

Existing customers with a valid EOPS/EMPS license can download everything from the LTM portal.

* LTM Core
^^^^^^^^^^

Existing users can download LTM Core from the portal at https://ltm.sintef.energy/files/ltm-releases/

Download and extract LTM Core into a folder. This folder contains binaries pyltm will use to run the models. If the folder is available in ``PATH``, there is no need to to anything more. If the folder is not in ``PATH``, the location of the binaries must be supplied when creating a session with pyltmapi.

* pyltm
^^^^^^^

``pyltm`` is the API exposing a Python interface into LTM Core and it's applications and data formats.

Can be downloaded from the portal at https://ltm.sintef.energy/files/?tax[wpdmcategory]=beta-releases

* pyltmapi
^^^^^^^^^^

Open source wrapper around ``pyltm``. Can be installed from PyPI or by cloning a Git repository.

Virtual environment
-------------------

Create a virtual environment and activate it:

.. tabs::

   .. group-tab:: Linux

      .. code:: bash

        python -m venv ltm-venv
        source ./ltm-venv/bin/activate
        pip install pyltmapi
        pip install pyltm*.whl

   .. group-tab:: Windows (PowerShell)

      .. code:: powershell

        python -m venv ltm-venv
        .\ltm-venv\Scripts\Activate.ps1
        pip install pyltmapi
        pip install pyltm*.whl

.. note::

    ``pyltmapi`` can also be installed by installing this repository with documentation and example notebooks.

    .. code:: bash

        git clone https://gitlab.sintef.no/energy/ltm/pyltmapi
        pip install -e ./pyltmapi/

(Optional): Add LTM core to ``PATH``.

.. tabs::

   .. group-tab:: Linux

      .. code:: bash

        export PATH=/path/to/ltm-core/bin:$PATH

   .. group-tab:: Windows (PowerShell)

      .. code:: powershell

        $env:PATH+=;C:\path\to\ltm-core\bin

Install pyltm with pip
----------------------

``pyltm`` itself is not availble through PyPI, but it is availble through SINTEF Gitlab instance. Contact SINTEF to get a token if you'd like to use this method instead of the above.

.. code-block:: bash

    export GITLAB_TOKEN=abc123
    pip install pyltm --index-url https://__token__:$GITLAB_TOKEN@https://gitlab.sintef.no/api/v4/projects/17012/packages/pypi/simple

Add repository information to ``~/.pypirc``.

.. code-block:: ini

    [distutils]
    index-servers =
        gitlab-pyltm

    [gitlab-pyltm]
    repository = https://gitlab.sintef.no/api/v4/projects/17012/packages/pypi/simple
    username = __token__
    password = abc123