.. QuESt Planning documentation master file, created by
   sphinx-quickstart on Wed Jul 17 13:44:28 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===============
QuESt Planning
===============

Welcome to the QuESt Planning documentation!

-----------------
Introduction
-----------------

Please take a look at the readme for detailed information about this project.

.. toctree::
   :maxdepth: 2
   :caption: README

   README.md

-----------------
Documentation
-----------------

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

   modules
   advanced_simulations


-----------------
Project Overview
-----------------

QuESt Planning is a framework for energy system planning and optimization. It includes modules for data handling, optimization, and results visualization.

-----------------
Modules
-----------------

The following are the main modules available in the QuESt Planning framework:

.. toctree::
   :maxdepth: 2
   :caption: Modules

   modules/explan
   modules/optimizer

-----------------
Submodules
-----------------

The following submodules provide additional functionality within the `explan` module:

.. toctree::
   :maxdepth: 2
   :caption: Submodules

   modules/explan_submodules/explan_constraints
   modules/explan_submodules/explan_data_handler
   modules/explan_submodules/explan_results_viewer
   modules/explan_submodules/explan_optimizer

-----------------
Acknowledgments
-----------------

QuESt Planning is developed by Sandia National Laboratories with contributions from several researchers and developers.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`