-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
50 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
{ | ||
"cells": [ | ||
{ | ||
"cell_type": "markdown", | ||
"metadata": {}, | ||
"source": [ | ||
"\n", | ||
"# Quickstart\n", | ||
"\n", | ||
"Icechunk is designed to be mostly in the background.\n", | ||
"As a Python user, you'll mostly be interacting with Zarr.\n", | ||
"If you're not familiar with Zarr, you may want to start with the [Zarr Tutorial](https://zarr.readthedocs.io/en/latest/tutorial.html)\n", | ||
"\n", | ||
"## Installation\n", | ||
"\n", | ||
"Icechunk can be installed using pip or conda:\n", | ||
"\n", | ||
"=== \"pip\"\n", | ||
"\n", | ||
" ```bash\n", | ||
" python -m pip install icechunk\n", | ||
" ```\n", | ||
"\n", | ||
"=== \"conda\"\n", | ||
"\n", | ||
" ```bash\n", | ||
" conda install -c conda-forge icechunk\n", | ||
" ```\n", | ||
"\n", | ||
"!!! note\n", | ||
"\n", | ||
" Icechunk is currently designed to support the [Zarr V3 Specification](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html).\n", | ||
" Using it today requires installing Zarr Python 3.\n" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"metadata": {}, | ||
"source": [] | ||
} | ||
], | ||
"metadata": { | ||
"language_info": { | ||
"name": "python" | ||
} | ||
}, | ||
"nbformat": 4, | ||
"nbformat_minor": 2 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters