Installation

Requirements

  • Python 3.10 or higher

  • pip package manager

Install from Source

First, clone the repository, create and activate a virtual environment, and then install the package in “editable” mode. This makes the focal command available in your terminal.

# Create and activate a virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Linux/macOS
venv\\Scripts\\activate    # On Windows

# If using anaconda
conda create --name your_env_name
conda activate your_env_name

git clone http://github.com/c-lombardi23/FOCAL.git
cd FOCAL

# Install the package in editable mode
pip install -e .

Verify the Installation

After installation, run the following command to see all available options and confirm the CLI is working:

focal --help

Dependencies

The package will automatically install these dependencies:

  • numpy

  • pandas

  • scikit-learn

  • tensorflow

  • keras-tuner

  • joblib

  • Pillow

  • pydantic

  • opencv-python

  • typer

  • click