User Guide¶
Welcome to the user guide, where you can learn more about using Zarr-Python!
Getting Started¶
New to Zarr-Python? Start here:
- Installation - Install Zarr-Python
- Quick start - Quick overview of core functionality
Core Concepts¶
Learn the essential building blocks:
- Arrays - Learn the fundamentals of working with arrays
- Groups - Organize your data with groups
- Attributes - Attach metadata to your arrays and groups
- Storage - Learn how data is stored and accessed
Configuration & Setup¶
Customize your experience:
- Runtime Configuration - Configure Zarr-Python for your needs
- Command-Line Interface - Migrate and manage Zarr metadata from the terminal
- V3 Migration - Upgrading from version 2 to version 3
Advanced Topics¶
Take your skills to the next level:
- Data Types - Learn about supported and extensible data types
- Performance - Optimize for speed and efficiency
- GPU - Leverage GPU acceleration
- Extending - Extend functionality with custom code
- Consolidated Metadata - Advanced metadata management
- Experimental Features - Preview features that may change at any time
Examples¶
Worked, end-to-end examples:
- Custom Data Type - Extend Zarr-Python with a user-defined data type
- Rectilinear Chunk Grids - Use variable-sized chunks along each dimension
Reference¶
- Glossary - Definitions of key terms (chunks, shards, codecs, etc.)
Need Help?¶
- Browse the API Reference for detailed function documentation
- Report issues on GitHub