.. comment:
    SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com>
    SPDX-License-Identifier: MPL-2.0

Welcome to the OpenSTEF documentation!
======================================

OpenSTEF is a Python package which is used to make short term forecasts for the energy sector.
It contains all components for the machine learning pipeline required to make a forecast.
The ``openstef`` Python package and its installation instructions are available at: https://pypi.org/project/openstef/.

If you're brand new, start by reading the :ref:`architecture_methodology_components` section. Otherwise, if you're ready
to start using OpenSTEF checkout the :ref:`user_guides`.

.. toctree::
    :maxdepth: 1

    about_openstef
    user_guides
    architecture_methodology_components
    api_reference
    community
    

More on OpenSTEF
================
- Find the latest information on the project on `the project's website <https://www.lfenergy.org/projects/openstef/>`_.
- You can also watch a `video about OpenSTEF <https://www.lfenergy.org/forecasting-to-create-a-more-resilient-optimized-grid/>`_, instead of reading about the project.
- Want to join the discussion? Join our `Teams channel <https://teams.microsoft.com/l/team/19%3ac08a513650524fc988afb296cd0358cc%40thread.tacv2/conversations?groupId=bfcb763a-3a97-4938-81d7-b14512aa537d&tenantId=697f104b-d7cb-48c8-ac9f-bd87105bafdc>`_.

Contributing
============
Please read `CONTRIBUTING.md <https://github.com/OpenSTEF/.github/blob/main/CONTRIBUTING.md>`_, `CODE_OF_CONDUCT.md <https://github.com/OpenSTEF/.github/blob/main/CODE_OF_CONDUCT.md>`_, and `PROJECT_GOVERNANCE.md <https://github.com/OpenSTEF/.github/blob/main/PROJECT_GOVERNANCE.md>`_ for details on the process for submitting pull requests to us.

License
=======
This project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.