QuickStart

Installation

1. Prerequisites

Make sure Python 3.9 is installed on your system. If you haven’t installed Python, you can download it from the official Python website.

2. Download the Project from GitHub

You can get the project source code by cloning the GitHub repository or downloading it as a ZIP file.

Clone via Git

git clone https://github.com/Alex6Crbt/XChroma.git
cd XChroma

Download ZIP

1. Go to the github repo (Alex6Crbt/XChroma).

2. Click the Code button and select Download ZIP.

3. Extract the ZIP file and navigate to the project directory.

cd XChroma

3. Create a Virtual Environment (Optional)

It is recommended to create a virtual environment to isolate project dependencies. Open a terminal or command prompt and run the following commands:

On macOS and Linux:

python3 -m venv myenv
source myenv/bin/activate

On Windows:

python -m venv myenv
myenv\Scripts\activate

4. Install Required Packages

In the virtual environment or your Python environment, run the following command to install the necessary packages:

pip install -r requirements.txt

5. Launch the App

Before running the application, make sure to connect the required hardware:

• Ocean Spectrometer: Ensure it is properly connected

• Arduino (if needed): If your setup includes an Arduino, connect it via USB and verify communication.

Once all necessary devices are connected, in the project directory run the application:

python main.py

Tip

Now that you have installed all the necessary prerequisites and dependencies, feel free to check the library documentation for more information on usage and different algorithms.