Installation

JuSPICE needs Python 3.12 (a specific version of the Python programming language) to run. The guides below use uv, a fast tool that downloads Python and everything JuSPICE needs for you, so you don’t have to install Python separately first. No prior experience with any of this is required — each guide explains every command in plain language as you go, so you can follow along even if this is the first time you’ve used a terminal.

Pick your operating system below for a full, step-by-step guide, including a dedicated troubleshooting page for when something doesn’t go as expected.

Library Structure

See a schematic of the whole repository tree before you install — what ships with JuSPICE, where the sample data lives, and which folders (models, generated images, virtual environments) get created automatically as you install and run it.

Linux

Install JuSPICE from a bash/zsh terminal on Linux distributions.

macOS

Install JuSPICE from Terminal on macOS (Intel or Apple Silicon).

Windows

Install JuSPICE from PowerShell on Windows.

IOPaint

Needed for any synthetic-data method that augments images (Aug, PB, PB_NonGauss, SDiff, DCGAN): install the IOPaint tool, which fills in the background it exposes, into its own environment — on any of the three OSes above.