Installation
=========================

.. _installation:

Using pip
--------------------------

To use synthpy, first install it using pip:

.. code-block:: console

   (.venv) $ pip install synthPy

In an anaconda environment
--------------------------

To use synthpy, first install it in your local anaconda enviroment:

.. code-block:: console

   (.venv) $ conda install synthPy

From github
--------------------------

To use synthpy, download the raw code from out github.

You can clone the repository directly for the latest changes:

.. code-block:: console

   (.venv) $ git clone https://github.com/MAGPIE-ICL/synthPy.git

Or you can download a specific release:

.. code-block:: console

   (.venv) $ <command to install a release>

Alternatively install using the github app or by cloning/installing a release directly from the `github repository <https://github.com/MAGPIE-ICL/synthPy/>`__