tessl/pypi-zarr

An implementation of chunked, compressed, N-dimensional arrays for Python

Overview

Eval results

Files

Configuration and Utilities

Name: tessl/pypi-zarr
Author: tessl

Configuration system and utility functions for zarr settings, metadata management, and debugging operations.

Capabilities

Configuration System

config: Config

Global configuration object for zarr settings.

Key configuration areas:

array.*: Array creation defaults
codecs.*: Codec configurations
storage.*: Storage backend settings

Methods:

config.get(key): Get configuration value
config.set(settings_dict): Update configuration
config.update(settings_dict): Merge configuration updates

Metadata Operations

def consolidate_metadata(
    store: StoreLike,
    path: str = None,
    zarr_format: int = None
) -> Group

Consolidate metadata of all nodes in a hierarchy for improved performance.

Data Management Utilities

def copy(
    source: Union[Array, Group, StoreLike],
    dest: Union[Array, Group, StoreLike],
    name: str = None,
    chunk_store: StoreLike = None,
    if_exists: str = 'raise',
    **kwargs
) -> tuple[int, int, int]

Copy arrays or groups between storage locations.

def copy_all(
    source: StoreLike,
    dest: StoreLike,
    **kwargs
) -> tuple[int, int, int]

Copy all arrays and groups from source to destination.

def copy_store(
    source: StoreLike,
    dest: StoreLike,
    **kwargs
) -> tuple[int, int, int]

Copy entire store contents.

Version Information

__version__: str

The zarr package version string.

Visualization and Debugging

def tree(
    grp: Group,
    expand: bool = None,
    level: int = None
) -> Any

Display tree representation of group hierarchy.

def print_debug_info() -> None

Print version and dependency information for debugging.

Usage Examples

Version Information

import zarr

# Check zarr version
print(f"zarr version: {zarr.__version__}")

# Use in version checks
if zarr.__version__ >= '3.0.0':
    print("Using zarr v3 features")

Configuration Management

import zarr
from zarr.codecs import BloscCodec

# View current configuration
print(zarr.config.get('array.v2_default_compressor'))

# Update global settings
zarr.config.set({
    'array.v2_default_compressor.numeric': 'zstd',
    'array.order': 'F'
})

# Configure default codecs
zarr.config.set({
    'codecs.blosc': 'zarr.codecs.BloscCodec',
    'codecs.blosc.cname': 'zstd',
    'codecs.blosc.clevel': 3
})

Metadata Consolidation

# Create group with many arrays
grp = zarr.group('large_dataset.zarr')
for i in range(100):
    grp.create_array(f'array_{i}', shape=(100, 100))

# Consolidate metadata for faster access
consolidated = zarr.consolidate_metadata('large_dataset.zarr')

# Opening consolidated group is much faster
fast_grp = zarr.open_consolidated('large_dataset.zarr')

Data Operations

# Copy data between stores
source = zarr.open('source_data.zarr')
dest_store = zarr.storage.LocalStore('backup/')
zarr.copy(source, dest_store)

# Tree visualization
grp = zarr.open_group('complex_dataset.zarr')
print(zarr.tree(grp, expand=True))

Install with Tessl CLI