index.md

API Reference

Complete reference documentation for the Zarr-Python API.

Core API

Essential Classes and Functions

• Array - The main Zarr array class for N-dimensional data
• Group - Hierarchical organization of arrays and subgroups
• Create - Functions for creating new arrays and groups
• Open - Opening existing Zarr stores and arrays

Data Operations

• Load - Loading data from Zarr stores
• Save - Saving data to Zarr format
• Convenience - High-level convenience functions

Data Types and Configuration

• Data Types - Supported NumPy data types and type handling
• Configuration - Runtime configuration and settings

Storage and Compression

• Codecs - Compression and filtering codecs
• Storage - Storage backend implementations and interfaces
• Registry - Codec and storage backend registry

API Variants

Zarr-Python provides both synchronous and asynchronous APIs:

• Async API - Asynchronous operations for concurrent access
• Sync API - Synchronous operations for simple usage

Abstract Base Classes

The ABC module defines interfaces for extending Zarr:

• Codec ABC - Interface for custom compression codecs
• Metadata ABC - Interface for metadata handling
• Store ABC - Interface for custom storage backends

Utilities

• Errors - Exception classes and error handling
• Testing - Utilities for testing Zarr-based code

Types

• Types - Useful types and classes for zarr function arguments. Any classes listed here are not meant for instantiation.

Migration and Compatibility

• Deprecated Functions - Legacy convenience functions
• Deprecated Creation - Legacy array creation functions

These deprecated modules are maintained for backward compatibility but should be avoided in new code.

Getting Help

• Check the User Guide for tutorials and examples
• Browse function signatures and docstrings in the API reference
• Report issues on GitHub
• Join discussions on the Zarr community forum