.. _development:
Developing in SimBLE
=================

Installing for development
---------------------------

Clone the repo and install necessary packages, which can be found in
pyproject.toml:

.. code:: sh

   # clone the repo however you like, eg
   git clone https://github.com/hoehnlab/simble

   # install requirements, up to date requirements can be found in pyproject.toml
   pip install <requirement>

   # run
   python3 -m simble -flags

Report a bug
----------------
If you encounter any bugs or issues while using SimBLE, please report them on the `GitHub Issues page <https://github.com/hoehnlab/simble/issues>`_.

Contributing to SimBLE
---------------------------

Please visit the `GitHub repo <https://github.com/hoehnlab/simble>`_ for more information on contributing.

Code documentation
---------------------------
The code documentation can be found in the `API Reference<modules>`_.