.. 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.

#################
Quick Start Guide
#################

Welcome to the eELib! We are here to help you get started!


Basic steps to get started with the eELib
-----------------------------------------

**First**, clone the repository and set up the environment using the instructions in the
:doc:`Installation Guide <reference_manual/installation_setup>`.
If completed, you can run one of our test scenarios, e.g. the one for a single family household with
a PV system and a battery storage system.

.. note::
   The eELib will soon be available to install via `PyPI - the Python Package Index <https://pypi.org/>`_.

**Next**, when using the eELib you should become familiar with the structure of the eELib in the
:doc:`Reference Manual <reference_manual/index>`, especially the section
:doc:`About the eELib <reference_manual/about_eelib>`.
You can get familiar with the :doc:`folder structure <reference_manual/folder_structure>` that is
currently used or have a look at the :doc:`FAQ & Glossary <reference_manual/faq_glossary>`.

**After getting to know the eELib a bit more**, you are now ready for our tutorials...


Learn how to use the eELib with some short tutorials
----------------------------------------------------

Try implementing a :doc:`new EMS strategy <tutorials/implement_strategy>`.
Or :doc:`add new implementations like models <tutorials/config_model>`.
Or if you are now ready for running your own simulation scenario, have a look at the
:doc:`scenario configuration tutorial <tutorials/create_scenario>`.

You can generally use the :doc:`Tutorials <tutorials/index>` section for further detailed
instructions and information on the setup of existing implementations.


Some additional helpful examples
--------------------------------

You can get helpful information on :doc:`how to use Git <reference_manual/git_workflow>` for version
control when implementing new stuff for the eELib.
Plus, have a look at the :doc:`FAQs <reference_manual/faq_glossary>` and in case of further
questions, we encourage you to contact the :ref:`authors <Disclaimer / Authors>`.