lamindb.integrations.save_vitessce_config

lamindb.integrations.save_vitessce_config(vitessce_config, description=None)

Validates and saves a VitessceConfig object.

If the VitessceConfig object references multiple artifacts, automatically creates a Collection and displays the “Vitessce button” next to it.

Guide: Vitessce.

Parameters:

  • vitessce_config (VitessceConfig) – A VitessceConfig object.

  • description (str | None, default: None) – A description for the VitessceConfig object. Is used as name for a Collection in case the VitessceConfig object references multiple artifacts.

Return type:

Artifact

Changed in version 0.76.12: Now assumes vitessce-python >= 3.4.0, which allows passing artifacts within VitessceConfig.

Changed in version 0.75.1: Now displays the “Vitessce button” on the hub next to the dataset. It additionally keeps displaying it next to the configuration file.

Changed in version 0.70.2: No longer saves the dataset. It only saves the VitessceConfig object.