#######
EVerest
#######

********************
Powering EV-Charging
********************

EVerest is ...

* a full-stack environment for EV-charging,
* a Linux Foundation Energy project,
* open-source,
* modular and customizable,
* licensed under the Apache 2.0 license to allow commercial-friendly use and
* backed by strong industry partners via great compatibility.

The EVerest project was initiated by Pionix GmbH to help with the
electrification of the mobility sector.

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Contents

   tutorials/index
   how-to-guides/index
   explanation/index
   reference/index

.. grid:: 1 2 2 2
   :gutter: 2

   .. grid-item-card:: High-level overview
      :link: explanation/high-level-overview
      :link-type: doc

      Get an understanding of the most important mechanisms and the
      architecture of EVerest. Best for everyone who enjoys some theory before
      the development work.

   .. grid-item-card:: Quick Start Guides
      :link: explanation/getting-started/index
      :link-type: doc

      We provide several entry points for a fast first experience with the
      framework. Whether you want to do a software-based simulation or start
      working with existing hardware, you will find your way here.

   .. grid-item-card:: GitHub source
      :link: https://github.com/everest
      :link-type: url

      In case you want to dig directly into the sources of EVerest, go for it!

   .. grid-item-card:: Discuss and collaborate
      :link: explanation/community-channels
      :link-type: doc

      Meet the EVerest community on different channels like Zulip, live calls
      and others.
      Learn how to contribute, submit bugs or feature ideas.

For a live experience, you can attend any live discussion session of the
EVerest contributors.
The events are open to anyone and can be found in the
`EVerest event calendar <https://zoom-lfx.platform.linuxfoundation.org/meetings/everest?view=week>`_.

.. raw:: html

   <hr>

*************************
All EVerest documentation
*************************

We have organized our documentation snippets in the following structure for
everybody to find their best way of learning:

.. grid:: 1 2 2 3
   :gutter: 2

   .. grid-item-card:: 🎓 Tutorials
      :link: tutorials/index
      :link-type: doc

      Learn a new skill by following our step-by-step experience.
      Best to start at the beginning.
      Example: **"Write your first hardware driver"**

   .. grid-item-card:: 🛠️ How-To Guides
      :link: how-to-guides/index
      :link-type: doc

      Practical guides to solve dedicated problems that focus on the important
      aspects.
      Best for people who already have experience with EVerest and want to get
      a fast way into a topic.
      Example: **"How can I activate the OCPP protocol?"**

   .. grid-item-card:: 📚 Explanations
      :link: explanation/index
      :link-type: doc

      More detailed information to deepen your knowledge.
      Go here for background information and concepts.
      Example: **How is authorization done in EVerest?**

   .. grid-item-card:: 📄 References
      :link: reference/index
      :link-type: doc

      Technical overviews, API documentation, auto-generated class definitions - go here.

   .. grid-item-card:: 📄 Q & A
      :link: qa/index
      :link-type: doc

      There might be some questions open - here is the place to look for answers.


***********************
Further important links
***********************

.. grid:: 2
   :gutter: 3

   .. grid-item::

      * `GitHub Repository <https://github.com/everest>`_
      * `Linux Foundation Energy <https://lfenergy.org/>`_

   .. grid-item::

      * `Discussion Forum (Zulip) <https://lfenergy.zulipchat.com/>`_
      * `Live Events & Calendar <https://zoom-lfx.platform.linuxfoundation.org/meetings/everest?view=week>`_