.. StarPSO documentation master file, created by
   sphinx-quickstart on Tue Dec  2 14:20:39 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: ../logo/main_logo.jpg
   :alt: StarPSO Logo
   :align: center

Welcome to StarPSO's documentation!
===================================
StarPSO is a research toolkit for particle swarm optimization algorithms. Using a fully
object-oriented paradigm it provides a set of classes that can be used to solve general
purpose optimization problems (constrained and unconstrained).

* **Free software:** GNU GPL Version 3
* **Github repository:** https://github.com/vrettasm/PyStarPSO
* **Python version(s):** 3.10+
* **Python dependencies:** NumPy, JobLib, Numba, Scipy

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

   modules
   examples

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

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