.. Mobile-Env documentation master file, created by
   sphinx-quickstart on Thu Oct 14 17:17:28 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. |Python package| image:: https://github.com/stefanbschneider/mobile-env/actions/workflows/python-package.yml/badge.svg
   :target: https://github.com/stefanbschneider/mobile-env/actions/workflows/python-package.yml
.. |Documentation Status| image:: https://readthedocs.org/projects/mobile-env/badge/?version=latest
   :target: https://mobile-env.readthedocs.io/en/latest/?badge=latest
.. |Publish| image:: https://github.com/stefanbschneider/mobile-env/actions/workflows/python-publish.yml/badge.svg
   :target: https://github.com/stefanbschneider/mobile-env/actions/workflows/python-publish.yml
.. |Colab| image:: https://colab.research.google.com/assets/colab-badge.svg
   :target: https://colab.research.google.com/github/stefanbschneider/mobile-env/blob/master/examples/demo.ipynb

|Python package| |Documentation Status| |Publish| |Colab|

Welcome to Mobile-Env's documentation!
======================================
This project is a minimalist, open-source environment for cell selection in wireless mobile networks.

`mobile-env` GitHub repository: https://github.com/stefanbschneider/mobile-env

This documentation provides:

1. :ref:`installation <installation>` instructions
2. :ref:`examples <examples>` showing the environments and demonstrating their usage;
3. :ref:`descriptions <components>` of the project's components.


Documentation contents
======================
.. toctree::
   :maxdepth: 2

   installation
   examples
   components
   source/modules

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

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