.. Author: elenia@TUBS
   Copyright 2024 elenia
   This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.

#############
Model Library
#############

This page is intended to provide an overview of relevant and suitable models and frameworks for the
purpose of the eELib. A few of the listed open-source models have already been integrated, and even
more will hopefully follow.
If you are missing a model, then do not hesitate to contact us, we are glad to extend this
library with as many fitting models as possible.

.. warning::

    This overview gives no guarantee that it is complete nor that all listed models are perfect or
    even suited for use inside the eELib.

- Electric vehicle (EV)

  - Car model to integrate charging or mobility profiles created with
    `emobpy <https://emobpy.readthedocs.io/en/latest/>`_

- PV system and wind power

  - `pvlib <https://github.com/pvlib/pvlib-python>`_
  - `feedinlib <https://github.com/oemof/feedinlib>`_
  - `windpowerlib <https://github.com/wind-python/windpowerlib>`_ plus an
    `oemof example <https://github.com/oemof/oemof-examples/blob/master/oemof_examples/windpowerlib/v0.2.x/modelchain_example.py>`_
  - `MIDAS-mosaik PV and wind data simulator <https://gitlab.com/midas-mosaik>`_

- Battery Energy Storage system

  - `PyBaMM <https://github.com/pybamm-team/PyBaMM>`_
  - `SimSES <https://gitlab.lrz.de/open-ees-ses/simses>`_
  - `openBatLib <https://github.com/fastrockstar/openBatLib>`_

- Grid

  - `pandapower <https://www.pandapower.org/>`_
  - `pandapipes <https://github.com/e2nIEE/pandapipes>`_ complements pandapower in the simulation of
    multi energy grids, in particular heat and gas networks
  - `GridLAB-D <https://github.com/arras-energy/gridlabd>`_
  - `Power Grid Model <https://github.com/PowerGridModel/power-grid-model>`_
  - `SIMONA <https://github.com/ie3-institute/simona>`_
  - `OpenDSS <https://sourceforge.net/projects/electricdss/>`_
  - `SmartGridToolbox <https://gitlab.com/SmartGridToolbox/SmartGridToolbox>`_
  - `GasNetSim <https://jugit.fz-juelich.de/iek-10/public/simulation/gasnetsim>`_
  - `HeatNetSim <https://gitlab-public.fz-juelich.de/iek-10/public/simulation/heatnetsim>`_

- Thermal energy systems

  - `hplib <https://github.com/FZJ-IEK3-VSA/hplib>`_
  - `oemof-thermal <https://github.com/oemof/oemof-thermal>`_
  - `oemof.thermal_building_model <https://github.com/oemof/thermal-building-model>`_
  - `oemof tespy (Thermal Engineering Systems in Python) <https://github.com/oemof/tespy>`_

- Power demand

  - `oemof demandlib <https://github.com/oemof/demandlib>`_
  - `LoadProfileGenerator <https://github.com/FZJ-IEK3-VSA/LoadProfileGenerator>`_

- Markets

  - `oemof Electricity Markets Lib <https://github.com/oemof/marketlib>`_
  - `AMIRIS <https://gitlab.com/dlr-ve/esy/amiris/amiris-py>`_
  - `Remark toolbox <https://gitlab.com/remark1/remark-toolbox>`_ with implementations on auctions, bidding strategies and various agents (operators, power systems etc.)
  - `MIDAS-mosaik <https://gitlab.com/midas-mosaik>`_ reactive power markets and (bidding) agents

- Others

  - `hydropowerlib <https://github.com/hydro-python/hydropowerlib>`_
  - `lemlab: agent-based development and testing of local energy market applications <https://github.com/tum-ewk/lemlab>`_
  - `Energy System Simulation and Optimization <https://github.com/Akkudoktor-EOS/EOS>`_ for BSS,
    PV, load, heatpump, electricity price, energy management
  - `MIDAS-mosaik <https://gitlab.com/midas-mosaik>`_ weather simulator

Regarding a possible integration into the eELib, other potential models also seem suitable and could
be added, respectively, self-developed for integration in the future:

- a simple/ **generic charging/discharging BSS** model
- a **synthetic EV** model generating driving profiles, consumption etc.
- a **biogas power** plant
- a `PowerFactory <https://www.digsilent.de/en/>`_ model to facilitate grid simulations (warning:
  not open-source!)
- other **types of energy management systems**: for districts, CTS, energy communities, ...
- **market models** for spot market, control power/energy market, local (flexibility) market,
  aggregator, energy supply company, ...
- a **weather** model, either using time series profiles (e.g. in csv files) or using an existing
  open-source framework

  Although the following are not explicitly models, there is a very helful website with different
  tutorials on python and various packages, like numpy, matplotlib, pandas etc.:
  `Data Science for ESM <https://fneum.github.io/data-science-for-esm/intro.html>`_
  It covers lots of tools that can be helpful when dealing with models for energy systems and is
  recommended for everyone from beginners to experts.