What is catalog.yaml?

Catalog YAML File (catalog.yaml): The the primary metadata and configuration file for a CartoScope dataset, serving as the entry point that allows CartoScope to parse, locate, and render all associated spatial data files.

What does catalog.yaml define?

• Dataset Metadata: Title, description, species, and technology details.
• Available Layers: The list of gene, factor, and background layers.
• File Locations: Relative or absolute paths to spatial coordinate databases (DuckDB/Parquet files), staining images, and factor assets.
• Layer-Specific Configuration: Custom settings like default aliases, color palettes, and layer group modes.

Related Pages

Manual Pages

• Load Your Own Data

How-to Guides

• How to Prepare your Data
• How to Load External Data