.. _quickstart:
Quick Start Guide
================

🚧 This guide is still under construction. 🚧

Installing SimBLE
-----------------

The easiest way to install SimBLE is with pip:

.. _install:
.. code:: sh

   pip install simble

Alternatively, clone the source code from GitHub and install from local files:

.. code:: sh

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

   # in the repo directory, install simble from local files
   pip install .

   # run
   python3 -m simble -flags
   # or
   simble -flags

To install for development, please refer to :ref:`development`.

Basic usage
-----------

.. include:: basic_command_line_usage.rst



Thank you for using SimBLE!