kub-dataset: Simulator Datasets

1. Purpose

This page documents simulator dataset commands under:

cemdb/simulators/vX.Y.Z

Simulator datasets store FMU model bundles organized by LOD directories and are managed through Girder.

For exhaustive command options and API notes, see kub-dataset: Full Reference.

2. Simulator Layout

cemdb/simulators/
└── v0.1.0/
    ├── manifest.json
    ├── lod0/
    ├── lod0.metadata.json
    ├── others/
    └── others.metadata.json

3. Simulator Command Synopsis

kub-dataset pack-simulator --version <version> [--lod <lod>] [--single]
kub-dataset unpack-simulator <archive> [--force]

kub-dataset push-simulator --version <version> [--lod <lod>] --api-key <key>
kub-dataset pull-simulator --version <version> [--lod <lod>] [--dvc] [--force]

kub-dataset list-simulators [--local] [--remote] [--version <version>] [--format {table,json}]
kub-dataset list-simulator-versions [--version <version>]

kub-dataset delete-simulator --version <version> [--lod <lod>] --api-key <key>

4. Core Workflows

4.1. Packaging and Restoration

# Pack all directories as independent archives
kub-dataset pack-simulator --version 0.1.0

# Pack one LOD only
kub-dataset pack-simulator --version 0.1.0 --lod 0

# Create one unified archive with manifest
kub-dataset pack-simulator --version 0.1.0 --single

# Restore from archive
kub-dataset unpack-simulator simulators-v0.1.0.zip --force

4.2. Remote Publication and Download

# Push complete simulator version to Girder
kub-dataset push-simulator --version 0.1.0 --api-key $GIRDER_API_KEY

# Pull all directories for a version
kub-dataset pull-simulator --version 0.1.0 --force

# Pull one LOD and create DVC tracking
kub-dataset pull-simulator --version 0.1.0 --lod 0 --dvc --force

4.3. Discovery and Cleanup

# Compare local/remote availability
kub-dataset list-simulators
kub-dataset list-simulators --remote --format json

# Delete one item or an entire version on Girder
kub-dataset delete-simulator --version 0.1.0 --lod others --api-key $GIRDER_API_KEY --yes
kub-dataset delete-simulator --version 0.1.0 --api-key $GIRDER_API_KEY --yes

5. Notes

  • --lod accepts numeric LOD (for example 0, 1, 2) or named directory such as others.

  • With unpack-simulator, unified archives include manifest.json; single-directory archives do not.

6. Related Pages