Skip to content

Commit 6f6577d

Browse files
committed
docs(notebooks): remove dev extra from install instructions
The installs pytest/ruff/pre-commit, not needed for running notebooks. Install guidance moved to getting-started docs. Signed-off-by: print-sid8 sidsub94@gmail.com
1 parent df02733 commit 6f6577d

File tree

4 files changed

+29
-3
lines changed

4 files changed

+29
-3
lines changed

docs/getting-started/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,32 @@ Verify the installation:
3636
python -c "import rasteret; print(rasteret.version())"
3737
```
3838

39+
### Running notebooks
40+
41+
=== "Jupyter / JupyterLab"
42+
43+
Jupyter runs each notebook in a **kernel** — a separate Python process.
44+
To use your Rasteret environment as a kernel:
45+
46+
```bash
47+
uv pip install ipykernel
48+
python -m ipykernel install --user --name rasteret --display-name "Rasteret"
49+
```
50+
51+
Then select the **Rasteret** kernel when you open a notebook.
52+
53+
=== "marimo"
54+
55+
[marimo](https://marimo.io) manages dependencies inline — no kernel
56+
registration needed. Just `uv pip install marimo` alongside Rasteret
57+
and run `marimo edit notebook.py`.
58+
59+
=== "VS Code"
60+
61+
VS Code auto-detects virtual environments. Open a `.ipynb` file,
62+
click the kernel picker (top-right), and select the Python interpreter
63+
from your Rasteret venv.
64+
3965
---
4066

4167
## Key concepts

notebooks/01_quickstart_xarray.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"id": "intro",
66
"metadata": {},
7-
"source": "# Quickstart: xarray\n\nThis notebook shows the minimal Rasteret workflow:\n\n1. **Build** a `Collection` from the dataset catalog (one-time, cached)\n2. **Fetch** pixels for a small AOI + time window as `xarray.Dataset`\n3. **Compute** NDVI\n\n### Requirements\n\n```bash\nuv sync --extra dev\n```"
7+
"source": "# Quickstart: xarray\n\nThis notebook shows the minimal Rasteret workflow:\n\n1. **Build** a `Collection` from the dataset catalog (one-time, cached)\n2. **Fetch** pixels for a small AOI + time window as `xarray.Dataset`\n3. **Compute** NDVI"
88
},
99
{
1010
"cell_type": "code",

notebooks/02_torchgeo_09_accelerator.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"id": "intro",
66
"metadata": {},
7-
"source": "# TorchGeo Integration\n\nRasteret's TorchGeo integration is **opt-in** and stays TorchGeo-native:\n\n- Rasteret produces a standard `GeoDataset`. All TorchGeo samplers, transforms, and collation work unchanged.\n- If your data is not a tiled GeoTIFF/COG, use TorchGeo's built-in `RasterDataset` directly.\n- Rasteret handles data access; TorchGeo handles the ML workflow.\n\n### Requirements\n\n```bash\nuv sync --extra dev --extra torchgeo\n```"
7+
"source": "# TorchGeo Integration\n\nRasteret's TorchGeo integration is **opt-in** and stays TorchGeo-native:\n\n- Rasteret produces a standard `GeoDataset`. All TorchGeo samplers, transforms, and collation work unchanged.\n- If your data is not a tiled GeoTIFF/COG, use TorchGeo's built-in `RasterDataset` directly.\n- Rasteret handles data access; TorchGeo handles the ML workflow."
88
},
99
{
1010
"cell_type": "code",

notebooks/05_torchgeo_comparison.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"id": "intro",
66
"metadata": {},
7-
"source": "# TorchGeo Benchmark\n\nThis notebook runs an **identical time-series workload** through two paths:\n\n- **Path A**: TorchGeo 0.9 `time_series=True`: sequential per-file reads via GDAL vsicurl\n- **Path B**: Rasteret `to_torchgeo_dataset(time_series=True)` with default backend routing\n\n**Controlled variables** (same across all paths):\n- AOI, date range, band (B04), scene count, chip size (256), batch size (2)\n- Same `RandomGeoSampler` → `DataLoader` → batch flow\n- Same output shape: `[batch, T, C, H, W]`, all timesteps stacked\n\nThe only difference is **how pixel data reaches the DataLoader**.\n\n### Requirements\n\n```bash\nuv sync --extra dev --extra torchgeo\n```"
7+
"source": "# TorchGeo Benchmark\n\nThis notebook runs an **identical time-series workload** through two paths:\n\n- **Path A**: TorchGeo 0.9 `time_series=True`: sequential per-file reads via GDAL vsicurl\n- **Path B**: Rasteret `to_torchgeo_dataset(time_series=True)` with default backend routing\n\n**Controlled variables** (same across all paths):\n- AOI, date range, band (B04), scene count, chip size (256), batch size (2)\n- Same `RandomGeoSampler` → `DataLoader` → batch flow\n- Same output shape: `[batch, T, C, H, W]`, all timesteps stacked\n\nThe only difference is **how pixel data reaches the DataLoader**."
88
},
99
{
1010
"cell_type": "code",

0 commit comments

Comments
 (0)