Getting Started
===============

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

Clone the repository:

.. code-block:: bash

   git clone https://github.com/naroser/pyswapp.git
   cd pyswapp

Environment setup
----------------

You will need a working Python environment. We recommend using the
Anaconda distribution, which provides the ``conda`` package manager.

The required dependencies are listed in the ``environment.yml`` file.

Create the environment by running:

.. code-block:: bash

   conda env create

Activate the environment:

.. code-block:: bash

   conda activate pyswapp

Install the library
-------------------

To install the library, run:

.. code-block:: bash

   cd code
   pip install .

Quick check
-----------

You can verify that the installation was successful by importing the package:

.. code-block:: python

   import pyswapp