.. Porcupy documentation master file

Porcupy: Crested Porcupine Optimizer
===================================

.. image:: /resources/img/logo.png
   :alt: Porcupy Logo
   :align: right
   :width: 200

A Python implementation of the Crested Porcupine Optimizer (CPO) algorithm, featuring GPU acceleration and comprehensive visualization tools.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started/quickstart
   getting_started/installation
   getting_started/configuration

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user_guide/basic_usage
   user_guide/advanced_features
   user_guide/visualization
   user_guide/gpu_acceleration
   user_guide/faq

.. toctree::
   :maxdepth: 2
   :caption: Examples

   examples/basic_optimization
   examples/advanced_optimization
   examples/real_world_applications

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api_reference/api_reference

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

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