.. _eops:

EOPS Example
============

This example demonstrates a simple EOPS model simulation. The system is not a realistic example but rather contains debug data used during the development of EOPS features.

For instance, the exogenous price series consists of values like 0, 10, 20, etc., making it easy to validate that the exogenous price data is correctly written to the expected files.

Since this is a debug setup, no in-depth analysis of input and output data is provided. However, there are still several interesting features worth discussing.

### Setting Up an EOPS Simulation
To start an EOPS simulation, two flags in the global settings must be configured:

- **`model_type`**: `"EOPS"`
- **`simulation_type`**: `"Serial"`

Validation
------------------

Additionally, the input data must adhere to several rules. To ensure correctness, a thorough validation is performed using the `validate_model()` function.

The following list summarized the validation rules:


- The model must contain **one and only one busbar**.
- Neither DC nor AC lines are allowed.
- A **main price series** must be present, but **secondary price series** are not allowed.
- A valid **detailed hydro system** is required, meaning at least **one reservoir and one plant** must be included.
- Aggregated hydro and batteries are not allowed.
- Spill and curtailment series must be set.
- Market steps of type `ts-spot` for both purchase and sale must be set.
- Other types of market steps are optional but not required.
- Loads are optional
- Wind and solar series are theoretically possible, but their real-world use is rare.
  - They are therefore restricted in the first version, but may be included later.
- Market calibration areas are not allowed

Runtime enviroment
------------------

The runtime enviroment is only avtivated if the modeltype is set to be EOPS.


Input File
------------------

All system details are specified in the `eops.json` file below.

.. collapse:: Expand to see full JSON listing.

   .. literalinclude:: eops.json
      :language: JSON
      :linenos:

Results
------------------

The link below provides access to a static Jupyter notebook where the LTM-API has been executed using the `eops.json` file as input. The notebook includes the results from the EOPS model presented through a series of figures.

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

   eops-example-run.ipynb

Additionally, you can download the input model file here:

* :download:`eops.json <eops.json>`