How to Prepare a Data Library¶

1. Prepare Your Datasets¶

Process your raw spatial omics data into the CartoScope-compatible format using CartLoader.

See How to Prepare your Data for detailed instructions.

2. Host Your Data on AWS¶

Upload the processed datasets to an AWS S3 bucket so they are accessible via HTTPS.

See How to Host Data in AWS for the required bucket policy and CORS configuration.

3. Generate the Metadata¶

CartoMint is the official tool for generating the metadata index files that CartoScope reads to populate a Data Library. It scans your hosted datasets, reads their catalog.yaml files, and produces a metadb/ folder.

Refer to the CartoMint documentation for installation and usage instructions.

Metadata from cartomint

After running CartoMint, you will have a metadb/ folder:

metadb/
├── datasets.parquet       # catalog of all datasets (required)
├── collections.parquet    # collection groupings (optional)
└── genes.parquet          # gene search index (optional)

The next step is to upload this metadb/ folder to your S3 bucket. The URL to this folder will then serve as your library root URL in CartoScope.

Related Pages

Concepts

Manual Pages

How-to Guides