tar_viewer

Package G4X-viewer Folder for Distribution

Tars a G4X-viewer folder by validating and organizing key viewer assets (e.g., .bin, .ome.tiff, .tar, etc.), generating the required dataset.config.json metadata file, and creating a .tar archive ready for use with the Single-File upload option in the G4X-viewer.

Usage

Note

Global options --threads/-t & --verbose/-v must be supplied on the main entrypoint before the subcommand:

g4x-helpers --threads 16 -v 2 COMMAND /path/to/g4x_data [OPTIONS]

use g4x-helpers --help for more information

argument description

---

G4X-DATA (argument)

Positional path to a G4X sample output directory.
The folder must follow the expected schema (e.g., run_meta.json, segmentation masks, panel files, single-cell outputs).
Provide this argument after command-specific options.

--in-place: (flag default: False)

By default, outputs are written to <G4X-DATA>/g4x_helpers/<command>, leaving the source data untouched.
Add --in-place to write results directly into the provided G4X-DATA folder (overwriting existing artifacts for that command).

⸻