diff --git a/.gitignore b/.gitignore index 185254f..deb1cb5 100644 --- a/.gitignore +++ b/.gitignore @@ -82,6 +82,7 @@ parts/ sdist/ var/ wheels/ +wheelhouse/ share/python-wheels/ *.egg-info/ .installed.cfg diff --git a/README.md b/README.md index 673ae27..beddc2f 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 648ec97..57275d7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = "peter.hill@york.ac.uk"}, - {name = "Joel Adams", email = "joel.adams@york.ac.uk"}, + { name = "Peter Hill", email = "peter.hill@york.ac.uk" }, + { name = "Joel Adams", email = "joel.adams@york.ac.uk" }, ] requires-python = ">=3.10" dependencies = [ @@ -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]", "ipykernel>=6.29.5"] [project.entry-points."xarray.backends"] sdf_engine = "sdf_xarray:SDFEntrypoint"