Getting started

Prerequisites

• Python 3.12 or greater
• Docker (recommended)

It is recommended to create a virtual environment to manage dependencies and avoid conflicts with other projects. Follow these steps to create and activate a virtual environment:

1. Open your terminal.

2. Navigate to your project directory.

3. Run the following command to create a virtual environment:

   python3.12 -m venv venv

4. Activate the virtual environment:

   • On macOS/Linux:

     source venv/bin/activate

   • On Windows:

     .\venv\Scripts\activate

   Steps to Install Docker

   1. Visit the Docker installation page.
   2. Follow the instructions specific to your operating system to download and install Docker.
   3. Verify the installation by running docker --version in your terminal.

Installation

To install the superalgorithm package along with all its requirements, use the following command inside your project directory:

pip install superalgorithm