Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@
.pytest_cache/
.mypy_cache/
.ruff_cache/

demo/data/
**/.ipynb_checkpoints/
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prerequisites

- **Python 3.14+**
- **Python 3.13+**
- **[uv](https://docs.astral.sh/uv/)** — Python package and project manager

## Setup
Expand Down
26 changes: 26 additions & 0 deletions demo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Demo

A notebook demonstrating chonkle's codec pipeline with Python and WebAssembly codecs,
using a real Sentinel-2 COG tile as test data.

## Setup

From the repo root:

```
uv sync --group notebook
```

## Running

```
uv run jupyter lab --notebook-dir=demo
```

Then open `chonkle-pipeline.ipynb` from the file browser.

## Notes

- The notebook downloads a ~200 MB Sentinel-2 COG on first run; subsequent runs skip the download.
- The HTTPS and OCI Wasm loading steps require internet access.
- A pre-compiled `tiff-predictor-2-c.wasm` is included for the local `file://` test.
599 changes: 599 additions & 0 deletions demo/chonkle-pipeline.ipynb

Large diffs are not rendered by default.

Binary file added demo/tiff-predictor-2-c.wasm
Binary file not shown.
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,8 @@ dev = [
"pytest>=9.0",
"ruff>=0.15",
]
notebook = [
"chunk-utils @ git+https://github.com/cylf-dev/chunk-utils.git@v0.1.0",
"jupyterlab",
"matplotlib",
]
1,648 changes: 1,646 additions & 2 deletions uv.lock

Large diffs are not rendered by default.

Loading