Skip to content

Inspect And Validate Archives

Use archive inspection commands before transferring, publishing, or restoring a .tgm file.

ARCHIVE_URI="file:///data/archives/MY_PRODUCT.tgm"

Show Metadata

firecube archive info --archive "$ARCHIVE_URI"

Expected output resembles:

Path:           /data/archives/MY_PRODUCT.tgm
Format:         v1 (multi-group)
Size:           0.00 MB
Groups:         data
Control-plane:  present

Group: data
  Source:    file:///data/products/MY_PRODUCT.zarr
  Codec:     zstd
  Variables:
    data: shape=[1000, 10] dtype=float32 chunks=[100, 10]

Use JSON for scripts:

firecube archive info --archive "$ARCHIVE_URI" --format json

Expected output resembles:

{
  "path": "/data/archives/MY_PRODUCT.tgm",
  "format": "v1",
  "size_bytes": 4432,
  "groups": ["data"],
  "has_controlplane": true
}

List Contents

firecube archive list --archive "$ARCHIVE_URI"

Expected output resembles:

Messages: 2

Group: data
  Source:  file:///data/products/MY_PRODUCT.zarr
  Codec:   zstd
  Objects: 1
    [0] data: shape=[1000, 10] dtype=float32 compression=zstd

[control-plane]
  Product: product.zarr

Validate Integrity

firecube archive validate --archive "$ARCHIVE_URI"

Expected output:

VALID: /data/archives/MY_PRODUCT.tgm (2 message(s), no issues)

Use --quick for a structure-only check:

firecube archive validate --archive "$ARCHIVE_URI" --quick

Expected output:

VALID: /data/archives/MY_PRODUCT.tgm (2 message(s), no issues)

Failure Recovery

Symptom Meaning Recovery
Path ... does not exist The archive path is wrong or create failed. Check ARCHIVE_PATH and rerun archive create.
requires the tensogram extras Archive support is not installed. Install firecube[tensogram] in the active environment.
Validation fails The archive is incomplete or corrupt. Recreate the archive from the source product.

Next Steps