Getting Started

Installation

1. Clone the repository

   $ git clone https://github.com/t-ded/algpy.git
   $ cd algpy
   

2. (Optional but strongly recommended) Set up virtual environment

   1. Using `venv`:

      $ python -m venv venv  # Alternatively, use python3
      $ source venv/bin/activate  # On Windows use `venv\Scripts\activate`
      

   2. Using `conda`:

      $ conda create --name algpy python=3.x  # Replace `3.x` with your desired Python version, preferably 3.12
      $ conda activate algpy
      

3. Install dependencies

   $ (venv) pip install -r algpy_src/requirements.txt
   

4. Run tests

   $ (venv) pytest