========
Packages
========

Here, we present a brief overview of the fundamental packages of QUEENS.

QUEENS
======

.. toctree::
   :maxdepth: 1

   queens


Data Processors
---------------

.. toctree::
   :maxdepth: 1

   queens.data_processors

Modules for extracting and processing data from simulation output files. 

Distributions
-------------

.. toctree::
   :maxdepth: 1

   queens.distributions

Modules for probability distributions. 

Drivers
-------

.. toctree::
   :maxdepth: 1

   queens.drivers

Modules for calling external simulation software. 

Iterators
---------

.. toctree::
   :maxdepth: 1

   queens.iterators

Modules for parameter studies, uncertainty quantification, sensitivity analysis, Bayesian inverse analysis, and optimization. 

Models
------

.. toctree::
   :maxdepth: 1

   queens.models

Modules for multi-query mapping of inputs to outputs, such as parameter samples to model evaluations. 

Parameters
----------

.. toctree::
   :maxdepth: 1

   queens.parameters

Modules grouping deterministic and continuous random variables or random fields. 

Schedulers
----------

.. toctree::
   :maxdepth: 1

   queens.schedulers

Modules for scheduling and submitting computational jobs. 

Stochastic Optimizers
---------------------

.. toctree::
   :maxdepth: 1

   queens.stochastic_optimizers

Modules containing stochastic optimizers. 

Utils
-----

.. toctree::
   :maxdepth: 1

   queens.utils

Modules containing utilities used throughout QUEENS. 

Variational Distributions
-------------------------

.. toctree::
   :maxdepth: 1

   queens.variational_distributions

Modules containing probability distributions for variational inference. 

Visualization
-------------

.. toctree::
   :maxdepth: 1

   queens.visualization

Modules for visualizing results. 


QUEENS interfaces
=================

.. toctree::
   :maxdepth: 1

   queens_interfaces

QUEENS interfaces for different packages. 


Fourc
-----

.. toctree::
   :maxdepth: 1

   queens_interfaces.fourc

Modules for interfacing the for multiphysics code 4C ( https://github.com/4C-multiphysics/4C) 


Example simulator functions
===========================

.. toctree::
   :maxdepth: 1

   example_simulator_functions

Modules containing example simulator functions for testing and benchmarking.