WORLDSAR Documentation

1-2. Getting Started

This page covers prerequisites and setup so the runtime workflow is reproducible.

1. Prerequisites

  • Linux environment with bash
  • apptainer (or compatible Singularity runtime)
  • hf CLI (Hugging Face CLI)
  • curl
  • For cluster mode only: qsub/PBS commands available

2. Repository Setup

From repository root, run:

git clone https://github.com/sirbastiano/WORLDSAR
cd WORLDSAR

Python environment setup (required for Hugging Face dependencies used to install support material):

uv sync

Alternative with pdm:

pdm install

Alternative with pip:

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .

Setup Intent

The project dependencies are declared in pyproject.toml and include Hugging Face-related packages (for example huggingface-hub and phidown) used by support-material download workflows. Core processing remains containerized via the SIF runtime and SNAP userdir.