PyTwinNet Documentation
========================

.. raw:: html

   <!-- Hero banner section -->
   <div align="center" style="margin-top:1rem;margin-bottom:1rem;">
     <img src="_static/img/pytwinnet-hero.svg" alt="PyTwinNet Hero" width="100%">
   </div>

.. raw:: html

   <!-- Logo and title section -->
   <div align="center">
     <img src="_static/img/pytwinnet-logo.svg" alt="PyTwinNet Logo" width="120">
     <h1 style="margin-top: 0;">PyTwinNet</h1>
     <p style="font-size:1.2em;">Wireless Digital Twin & Network Optimization Library</p>
     <p><a class="btn" href="https://pypi.org/project/pytwinnet/">Install</a> |
        <a class="btn" href="https://github.com/OluwaseyiWater/PyTwinNet">GitHub</a></p>
   </div>
   <hr style="margin:1.5rem 0;border:none;border-top:1px solid #E5E7EB;">


.. grid:: 1 1 2 2
   :gutter: 2

   .. grid-item-card:: Get Started
      :link: getting_started
      :text-align: left
      :shadow: sm

      Install, quickstart, and your first twin.

   .. grid-item-card:: User Guide
      :link: user_guide/overview
      :text-align: left
      :shadow: sm

      Concepts, environment, propagation, scenarios, optimization.

   .. grid-item-card:: Examples
      :link: examples/index
      :text-align: left
      :shadow: sm

      End-to-end scenarios with code & figures.

   .. grid-item-card:: More Examples
      :link: index
      :text-align: left
      :shadow: sm

      End-to-end scenarios with code & figures.

   .. grid-item-card:: API Reference
      :link: api/index
      :text-align: left
      :shadow: sm

      Browse classes and functions.

.. toctree::
   :maxdepth: 2
   :hidden:

   getting_started
   user_guide/overview
   user_guide/propagation_math
   user_guide/ris_mimo
   user_guide/rl_power
   user_guide/acceleration
   user_guide/dashboard
   user_guide/config_runs
   examples/index
   examples/sinr_math
   api/index