*****************************************
OpenFE 2024 Industry Benchmarking Project
*****************************************


Welcome to the OpenFE 2024 Benchmarking Project!


This website contains information, plans, and annoucements related to the
Open Free Energy 2024 Industry Benchmarking Project.


This project is an industry-led effort to test and validate the `OpenFE software stack <https://docs.openfree.energy/en/stable/>`_.

Validation will be achieved via two separate benchmarking efforts:

* :ref:`Benchmarking against public datasets <public_overview>`
* :ref:`Benchmarking against private datasets <private_overview>`


More details about getting involved, or different portions of this project can be found below or in relevant sub-links.


Getting Involved
****************


The industry benchmark project is open to all OpenFE industry partners. If
you wish to participate, please :ref:`get in touch with the OpenFE team <get_in_touch>`
for more information.


Public Dataset Benchmarks
*************************


**The public benchmark is now live!**

To get started with this project please have a look at the :ref:`public dataset benchmarks overview <public_overview>` for instructions on how to get started.


Private Dataset Benchmarks
**************************

**The private benchmark is now live!**

To get started with this project please have a look at the :ref:`private dataset benchmarks overview <private_overview>` for instructions on how to get started.


Acknowledgements
****************

We thank the OpenFE industry partners for their participation, guidance, and funding in this initiative.


.. toctree::
   :maxdepth: 5
   :caption: Table of Contents
   :hidden:

   installation
   ./public/overview
   ./private/overview
   get-in-touch
   prep_and_debug


.. toctree::
   :maxdepth: 1
   :caption: Extra Resources

   reviewersguide