README.md

Installation

To get started, follow the steps below.

1. Clone the Repository

   git clone [https://github.com/pedrolisboa/poseidon.git](https://github.com/pedrolisboa/poseidon.git)
   cd your-repository

Set Up Your Environment

You have two options for setting up your project environment. You can either create a local virtual environment on your machine or build and run the project inside a Docker container.

---

Option 1: Create a Local Virtual Environment

This is a great choice for keeping project dependencies isolated from your system's Python installation.

• On macOS / Linux:

  python3 -m venv venv
  source venv/bin/activate

• On Windows:

  python -m venv venv
  .\venv\Scripts\activate

---

Option 2: Build and Run with Docker

Using Docker encapsulates the entire environment, ensuring it works consistently everywhere. This is the recommended approach for avoiding "it works on my machine" issues.

1. Build the Docker image:

   docker build -t your-image-name .

2. Run the container and access its shell:

   docker run -it --rm your-image-name bash

3. Install Dependencies Install the package using pip.

   pip install .