Usage
=====

Environment
-----------

We suggest using perturbopy inside a Python virtual environment created with `venv` or `anaconda`. We will call this environment `perturbopy`.

.. _Conda activate:

Here is an example to create and activate this environment with `anaconda`:

.. code-block:: console

   $ conda create -n perturbopy python=3.10
   $ conda activate perturbopy
   (perturbopy) $ python --version
   Python 3.10.0

.. _Installation:

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

To use perturbopy, you can chose on the following ways: 

1. From PyPI (default option)

You can install perturbopy from PyPI using pip:

.. code-block:: console

   (perturbopy) $ pip install perturbopy


2. From the source code

First clone it from the GitHub repository:

.. code-block:: console

   (perturbopy) $ git clone https://github.com/perturbo-code/perturbopy.git

Then, navigate to the `perturbopy` folder and install it with pip:

.. code-block:: console

   (perturbopy) $ pip install .