Skip to content

Commit

Permalink
Add jupyter optional-dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelLucaAdams committed Nov 14, 2024
1 parent 05f5a60 commit cde9b15
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ Install from PyPI with:
pip install sdf-xarray
```

> [!NOTE]
> For use within jupyter notebooks, run this additional command after installation:
>
> ```bash
> pip install "sdf-xarray[jupyter]"
> ```
or from a local checkout:
```bash
Expand Down
30 changes: 14 additions & 16 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
[build-system]
requires = [
"scikit-build-core>=0.3",
"setuptools_scm",
"numpy>=2.0.0",
"cython>=3.0",
"scikit-build-core>=0.3",
"setuptools_scm",
"numpy>=2.0.0",
"cython>=3.0",
]
build-backend = "scikit_build_core.build"

[project]
name = "sdf-xarray"
dynamic = ["version"]
license = {file = "LICENCE"}
license = { file = "LICENCE" }
readme = "README.md"
authors = [
{name = "Peter Hill", email = "[email protected]"},
{name = "Joel Adams", email = "[email protected]"},
{ name = "Peter Hill", email = "[email protected]" },
{ name = "Joel Adams", email = "[email protected]" },
]
requires-python = ">=3.10"
dependencies = [
Expand All @@ -27,18 +27,16 @@ description = "Provides a backend for xarray to read SDF files as created by the

[project.optional-dependencies]
docs = [
"sphinx >= 5.3",
"sphinx_autodoc_typehints >= 1.19",
"sphinx-book-theme >= 0.4.0rc1",
"sphinx-argparse-cli >= 1.10.0",
"sphinx-inline-tabs",
]
test = [
"pytest >= 3.3.0",
"dask[complete]",
"sphinx >= 5.3",
"sphinx_autodoc_typehints >= 1.19",
"sphinx-book-theme >= 0.4.0rc1",
"sphinx-argparse-cli >= 1.10.0",
"sphinx-inline-tabs",
]
test = ["pytest >= 3.3.0", "dask[complete]"]
lint = ["ruff"]
build = ["cibuildwheel[uv]"]
jupyter = ["dask[diagnostics] >= 2024.7.1", "ipykernel>=6.29.5"]

[project.entry-points."xarray.backends"]
sdf_engine = "sdf_xarray:SDFEntrypoint"
Expand Down

0 comments on commit cde9b15

Please sign in to comment.