SweepExp
========

.. toctree::
   :maxdepth: 1
   :hidden:

   installation
   usage/index
   package_api

Features
--------
- **Flexible Experimentation with Parameter Grids:** SweepExp simplifies running experiments over a grid of parameter combinations. Results are stored in an xarray dataset for easy access and analysis.
- **Parallelization:** Support for parallelization using multiprocessing, or MPI for high-performance computing.
- **User-Friendly API:**  Define the function to be tested, set up parameter sweeps, and specify return types effortlessly.

Navigation
----------

.. grid:: 1 2 2 3
   :margin: 4 4 0 0
   :gutter: 2

   .. grid-item-card::  Installation
      :link: installation
      :link-type: doc

      How to install.

   .. grid-item-card::  Usage
      :link: usage/index
      :link-type: doc

      How to use.

   .. grid-item-card::  API
      :link: package_api
      :link-type: doc

      The full API documentation.


Indices and tables
------------------

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