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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Thanks for contributing a notebook to the `spatialdata-plot` gallery.
## Setup

```bash
git clone https://github.com/scverse/spatialdata-plot-notebooks.git
cd spatialdata-plot-notebooks
git clone https://github.com/scverse/spatialdata-plot-tutorials.git
cd spatialdata-plot-tutorials
pip install -e ".[exec,dev]"
pre-commit install
```
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# spatialdata-plot-notebooks
# spatialdata-plot-tutorials

Executable notebooks demonstrating [spatialdata-plot] on real spatial-omics
datasets. Rendered into the [spatialdata-plot documentation][docs] as a
Expand All @@ -21,8 +21,8 @@ re-executes every notebook against the latest `spatialdata-plot` release.
## Running notebooks locally

```bash
git clone https://github.com/scverse/spatialdata-plot-notebooks.git
cd spatialdata-plot-notebooks
git clone https://github.com/scverse/spatialdata-plot-tutorials.git
cd spatialdata-plot-tutorials
pip install -e ".[exec]"
jupyter lab
```
Expand Down
Binary file added _static/img/multi_panel_color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "spatialdata-plot-notebooks"
name = "spatialdata-plot-tutorials"
version = "0.0.0"
description = "Executable notebooks demonstrating spatialdata-plot on real spatial-omics datasets."
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.11"
requires-python = ">=3.12"
authors = [{ name = "scverse" }]

# The package itself ships no Python code; this is a pyproject for tooling +
# environment management. The `exec` extra installs everything needed to run
# the notebooks end-to-end.
[project.optional-dependencies]
exec = [
"spatialdata-plot[interactive]>=0.4.0",
"spatialdata-plot[interactive]>=0.4.1",
"squidpy",
"jupyter",
"ipykernel",
Expand All @@ -29,7 +29,7 @@ dev = [
]

[project.urls]
Source = "https://github.com/scverse/spatialdata-plot-notebooks"
Source = "https://github.com/scverse/spatialdata-plot-tutorials"
Documentation = "https://spatialdata.scverse.org/projects/plot/en/latest/"

[tool.hatch.build.targets.wheel]
Expand All @@ -45,24 +45,24 @@ channels = ["conda-forge"]
platforms = ["linux-64", "osx-arm64"]

[tool.pixi.dependencies]
python = ">=3.11"
python = ">=3.12"
jupyterlab = "*"
ipykernel = "*"
nbconvert = "*"
watermark = "*"

[tool.pixi.pypi-dependencies]
spatialdata-plot = { version = ">=0.4.0", extras = ["interactive"] }
spatialdata-plot = { version = ">=0.4.1", extras = ["interactive"] }
squidpy = "*"

[tool.pixi.tasks]
kernel-install = 'python -m ipykernel install --user --name sdata-plot-notebooks --display-name "sdata-plot-notebooks"'
kernel-install = 'python -m ipykernel install --user --name sdata-plot-tutorials --display-name "sdata-plot-tutorials"'
lab = "jupyter lab"
execute = "jupyter nbconvert --to notebook --execute --inplace tutorials/*.ipynb examples/*.ipynb"

[tool.ruff]
line-length = 120
target-version = "py311"
target-version = "py312"

[tool.ruff.lint]
# Notebooks have different idioms than production code (bare expressions to
Expand Down
11 changes: 11 additions & 0 deletions tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ perceptually well-spaced or colourblind-safe palettes with
`make_palette` and `make_palette_from_data`.
:::

:::{grid-item-card} Multi-panel colouring
:link: /notebooks/tutorials/multi_panel_color
:link-type: doc
:img-top: /notebooks/_static/img/multi_panel_color.png

Render several colourings at once by passing a list to `color=`,
scanpy-style, with per-panel legends/colourbars, shared `palette`/`cmap`,
and `ncols` grid control.
:::

:::{grid-item-card} Speeding up rendering
:link: /notebooks/tutorials/performance
:link-type: doc
Expand All @@ -44,5 +54,6 @@ of shapes and points.

getting_started
color_and_palette
multi_panel_color
performance
```
410 changes: 410 additions & 0 deletions tutorials/multi_panel_color.ipynb

Large diffs are not rendered by default.

Loading