polarcbo
================================================================

Polarized Consensus Based Optimization and Sampling

.. image:: https://img.shields.io/pypi/v/polarcbo.svg
   :target: https://pypi.org/project/polarcbo/
   :alt: PyPI - Python Version

The ``polarcbo`` package provides a framework for optimizing and sampling
for consensus based optimization (CBO) and polarized CBO (PCBO).

Installation
------------
The package can be installed via ``pip``:

.. code-block:: bash

   pip install polarcbo

Usage
-----

The most important modules are documented below.

.. toctree::
   :maxdepth: 1
   :caption: Contents

   dynamic
   noise
   objectives
   scheduler
   utils




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

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