.. _Lucy documentation master file:


Welcome to Lucy's documentation!
================================

.. image:: ./_images/Lucy_Logo.png

This documentation explains and illustrates how to use Lucy, the backend of the d3VIEW platform. It aims to make the experience of navigating Lucy smoother and easier.

+---------------------------------------------------------+---------------------------------------------------------+----------------------------------------------------------------+
| .. image:: /_images/icons/icon_extract.png              | .. image:: /_images/icons/icon_proxy.png                | .. image:: /_images/icons/icon_admin.png                       |
|    :target: extractors.html                             |    :target: proxy_service.html                          |    :target: admin_guide.html                                   |
|    :width: 50%                                          |    :width: 50%                                          |    :width: 50%                                                 |
|    :align: center                                       |    :align: center                                       |    :align: center                                              |         
| .. centered:: :ref:`Extractors Guide <extractorsguide>` | .. centered:: :ref:`Proxy Setup Guide <LucyProxyIndex>` | .. centered:: :ref:`Administrative Guide <LucyAdminGuide>`     |
+---------------------------------------------------------+---------------------------------------------------------+----------------------------------------------------------------+
| .. image:: /_images/icons/icon_enduser.png              | .. image:: /_images/icons/icon_ML.png                   | .. image:: /_images/icons/icon_cronjobs.png                    |
|    :target: admin_end_user_guide.html                   |    :target: lucyml.html                                 |    :target: cronjobs_index.html                                |
|    :width: 50%                                          |    :width: 50%                                          |    :width: 50%                                                 |
|    :align: center                                       |    :align: center                                       |    :align: center                                              |         
| .. centered:: :ref:`End User Guide <enduser guide>`     | .. centered:: :ref:`Machine Learning Guide <lucyML>`    | .. centered:: :ref:`Cronjobs Guide <Lucy cronjob master file>` |
+---------------------------------------------------------+---------------------------------------------------------+----------------------------------------------------------------+


.. toctree::
   :caption: Table of Contents:
   :hidden:
   :numbered: 2
   :maxdepth: 2

   Intro.rst
   admin_end_user_guide.rst
   admin_guide.rst
   lucyml.rst
   extractors.rst
   cronjobs_index.rst
   bms_readme.rst
   bms_user_guide.rst
   cartech_readme.rst
   hvac_readme.rst
   plugin_unit_tests.rst
   extract_mme.rst
   proxy_index.rst


To review a list of new features, enhancements and bug fixes, check out d3VIEW's `Release Notes at this link. <https://www.d3view.com/release-notes-2022-001>`_