Installation
------------

**msbuddy** requires Python version 3.9+. There are a variety of ways to install **msbuddy**.

Option 1: Using pip (recommended)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**msbuddy** is available on PyPI, you can install it via ``pip``:

.. code-block:: bash

   pip install msbuddy

To perform formula annotation, you also have to install the `lightgbm <https://github.com/microsoft/LightGBM/tree/master/python-package>`_ package.

.. code-block:: bash

   pip install lightgbm


Option 2: From source
~~~~~~~~~~~~~~~~~~~~~
You can also install **msbuddy** from source:

.. code-block:: bash

   git clone https://github.com/Philipbear/msbuddy.git

Option 3: From PyPI release
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alternatively, you can download the latest release from `PyPI <https://pypi.org/project/msbuddy/#history>`_ and install it:

.. code-block:: bash

   tar -zxvf msbuddy-0.3.0.tar.gz