====================================
KOSMOS Documentation
====================================

.. container:: hero

   **KOSMOS** — Koordinations-, Optimierungs- und Simulations-Software für Modulare Quanten-Systeme in 6G Netzwerken

   (German for *Coordination, Optimization and Simulation Software for Modular Quantum Systems in 6G Networks*)

----

Overview
========

KOSMOS is a Python framework for simulating both classical and quantum networks. It provides:

* **Topology modeling** — Define networks with nodes and links (classical and quantum)
* **Machine learning** — Conduct centralized and federated learning experiments

----

Getting Started
===============

New to KOSMOS? Start here:

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

   getting_started
   examples/index

----

Examples
========

Check the :doc:`examples/index` section.

----

API Reference
=============

API documentation for all modules:

.. toctree::
   :maxdepth: 1
   :caption: API Documentation
   :glob:

   api/kosmos/*/index