Linux Installation

Chloros is distributed for Linux as .deb packages that install the CLI and backend. The Python SDK is installed separately via pip.


Linux amd64 (x86_64)

System Requirements

Requirement
Minimum
Recommended

Distribution

Ubuntu 20.04+ / Debian 11+

Ubuntu 22.04+

Processor

x86_64 (Intel/AMD)

Intel Core i7 or better

Memory (RAM)

8GB

16GB or more

Graphics Card

None (CPU processing)

NVIDIA GPU with 4GB+ VRAM

Storage

2GB free space

SSD with 10GB+ free space

Python

Python 3.7+ (for SDK)

Python 3.10+

Installation

Download the .deb package and install:

sudo dpkg -i chloros-amd64.deb

Verify the installation:

chloros-cli --version

Linux arm64 (NVIDIA Jetson)

System Requirements

Requirement
Minimum
Recommended

Platform

NVIDIA Jetson with JetPack 6

Jetson Orin NX 16GB or AGX Orin

JetPack

JetPack 6.x

Latest JetPack 6

Memory (RAM)

8GB (shared GPU/CPU)

16GB+ shared

Storage

2GB free space

NVMe SSD with 10GB+ free

Python

Python 3.7+ (for SDK)

Python 3.10+

Installation

Download the JetPack 6 .deb package and install:

Verify the installation:

For detailed Jetson setup including thermal management and field deployment, see the NVIDIA Jetson Guide.


Python SDK Installation (All Linux)

The Python SDK is installed separately via pip and works on both amd64 and arm64:

To include optional progress streaming support:

Verify the SDK:

circle-info

The .deb package installs the Chloros CLI and backend. The Python SDK is a separate pip package that communicates with the backend via a local HTTP API.


Configuration Directories

Chloros on Linux follows the XDG Base Directory Specificationarrow-up-right:

Purpose
Linux Path
Windows Equivalent

Configuration

~/.config/chloros/

%APPDATA%\Chloros\

Data / Projects

~/.local/share/chloros/

%LOCALAPPDATA%\Chloros\

Cache / Credentials

~/.cache/chloros/

%APPDATA%\Chloros\cache\

Backend Executable Locations

The .deb package installs the backend to a standard location. The CLI and SDK auto-detect the backend path:

Installation Method
Backend Path

.deb package

/usr/lib/chloros/chloros-backend

Manual / custom

/opt/mapir/chloros/backend/chloros-backend

You can override the backend path with the --backend-exe CLI flag or the backend_exe SDK constructor parameter.


First-Time Setup

1. Activate Your License

A Chloros+ license is required for CLI and SDK access:

2. Check Your License Status

3. Process Your First Dataset

4. Run System Diagnostics

Verify that your system is configured correctly:

This runs 7 diagnostic checks including version, backend startup, API connectivity, and CUDA/GPU availability.


Bash Scripting Examples

Process Multiple Datasets

Process with Custom Settings

Automated Processing with Cron

Add to your crontab (crontab -e) to process new datasets automatically:

Python SDK Example


Troubleshooting

CLI Not Found After Installation

If chloros-cli is not found after installing the .deb package:

Permission Denied

Backend Failed to Start

CUDA Not Detected

Missing Shared Libraries


Updating Chloros on Linux

Use the built-in update command to check for and install updates:


Next Steps

Last updated