pyproject definition (#1067)

* use pyproject.toml instead of setup.py for project definition

* update env_climada.yml

* pitch black

* increase consistency, add comments in env_climada.yml

* clean up

* remove the 'dev' extra dependencies

* update config and doc

* fix ci.yml workflow

* adapt install_env.sh script

* reformat pip installation path

* force rebuild

* setuptools_scm is actually needed for package data

Author: emanuel-schmid

.github/workflows/ci.yml

@@ -47,7 +47,7 @@ jobs:
       -
         name: Install CLIMADA
         run: |
-          python -m pip install ".[test]"
+          python -m pip install "./[dev]"
       -
         name: Run Unit Tests
         run: |

climada/engine/unsequa/calc_cost_benefit.py

@@ -398,7 +398,7 @@ def _map_costben_calc(
             ent_future=ent_fut,
             save_imp=False,
             assign_centroids=False,
-            **cost_benefit_kwargs
+            **cost_benefit_kwargs,
         )
         # Extract from climada.impact the chosen metrics
         uncertainty_values.append(

doc/getting-started/install.rst

@@ -263,7 +263,8 @@ They are also not needed for using CLIMADA.
 However, if you want to develop CLIMADA, we strongly recommend you install them.
 
 With the ``climada_env`` activated, enter the workspace directory and then the CLIMADA repository as above.
-Then, add the ``dev`` extra specification to the ``pip install`` command (**mind the quotation marks**, and see also `pip install examples <https://pip.pypa.io/en/stable/cli/pip_install/#examples>`_):
+Then, add the ``test`` extra specification to the ``pip install`` command (**mind the quotation marks**,
+ and see also `pip install examples <https://pip.pypa.io/en/stable/cli/pip_install/#examples>`_):
 
 .. code-block:: shell
 
@@ -277,12 +278,10 @@ The CLIMADA Python package defines the following `extras <https://peps.python.or
 
    * - Extra
      - Includes Dependencies...
-   * - ``doc``
-     - for building documentation
-   * - ``test``
-     - for running and evaluating tests
    * - ``dev``
-     - combination of ``doc`` and ``test``, and additional tools for development
+     - for developers, needed for running and evaluating tests and pre-commit actions
+   * - ``doc``
+     - for building the documentation files from in-source pydoc annotations
 
 The developer dependencies also include `pre-commit <https://pre-commit.com/#intro>`_, which is used to install and run automated, so-called pre-commit hooks before a new commit.
 In order to use the hooks defined in ``.pre-commit-config.yaml``, you need to install the hooks first.

pyproject.toml

@@ -1,3 +1,91 @@
 [build-system]
-requires = ["setuptools >= 64"]
+requires = ["setuptools >= 64", "setuptools_scm >= 8"]
 build-backend = "setuptools.build_meta"
+
+[project]
+name = "climada"
+version = "6.0.2-dev"
+description = "Framework for climate risk assessment and adaptation option appraisal"
+readme = "README.md"
+requires-python = ">=3.10,<3.13"
+license = { text = "GNU General Public License v3 (GPLv3)" }
+authors = [
+    { name = "ETH", email = "climada-info@sympa.ethz.ch" }
+]
+keywords = ["climate", "adaptation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Atmospheric Science",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Topic :: Scientific/Engineering :: Mathematics"
+]
+dependencies = [
+    "bayesian-optimization",
+    "bottleneck",
+    "cartopy",
+    "cfgrib",
+    "contextily",
+    "dask",
+    "deprecation",
+    "fiona",
+    "gdal",
+    "geopandas",
+    "h5py",
+    "haversine",
+    "matplotlib",
+    "netcdf4",
+    "numba",
+    "openpyxl",
+    "overpy",
+    "pandas",
+    "pathos",
+    "peewee",
+    "pillow",
+    "pint",
+    "pyarrow",
+    "pycountry",
+    "pyproj",
+    "rasterio",
+    "salib",
+    "scikit-learn",
+    "seaborn",
+    "sparse",
+    "statsmodels",
+    "tables",
+    "tabulate",
+    "tqdm",
+    "xarray",
+    "xlrd",
+    "xlsxwriter"
+]
+
+[project.optional-dependencies]
+doc = [
+    "ipython",
+    "myst-nb",
+    "readthedocs-sphinx-ext>=2.2",
+    "sphinx",
+    "sphinx-book-theme",
+    "sphinx-markdown-tables",
+    "sphinx-design",
+    "sphinx-mdinclude"
+]
+dev = [
+    "ipython",
+    "mccabe>=0.6",
+    "pylint>=3.0",
+    "pytest",
+    "pytest-cov",
+    "pytest-subtests",
+    "pre-commit"
+]
+
+[project.urls]
+Homepage = "https://github.com/CLIMADA-project/climada_python"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["climada*"]

requirements/env_climada.yml

@@ -3,43 +3,48 @@ channels:
   - conda-forge
   - nodefaults
 dependencies:
-  - bottleneck>=1.4
+  - bayesian-optimization>=1.5,<2.0
+  - bottleneck>=1.5
   - cartopy>=0.24
   - cfgrib>=0.9
   - contextily>=1.6
-  - dask>=2025.2
-  - eccodes>=2.40
+  - dask>=2025.5
+  - deprecation>=2.1
+  - eccodes>=2.41
   - fiona>=1.10
   - gdal>=3.10
   - geopandas>=0.14
-  - h5py>=3.12
+  - h5py>=3.13
   - haversine>=2.9
   - matplotlib-base>=3.10
   - netcdf4>=1.7
   - numba>=0.61
   - numexpr>=2.10
   - openpyxl>=3.1
-  - osm-flex>=1.1
+  - osm-flex>=1.1  # this is only required for running the tutorials, not for the CLIMADA package itself
   - pandas>=2.1
   - pathos>=0.3
+  - peewee>=3.17
   - pint>=0.24
   - pip
+  - pyarrow>=20.0
   - pycountry>=24.6
   - pyproj>=3.7
-  - pytables>=3.10
+  - pytables>=3.10  # this is the name of the pypi 'tables' package on conda-forge
+  - python>=3.10,<3.13
   - pyxlsb>=1.0
   - rasterio>=1.4
   - requests>=2.32
-  - rtree>=1.3,<1.4  # 1.4.0 doesn't pass the `pip check`
+  - rtree>=1.3,<1.4  # 1.4.0 doesn't pass the `pip check`, needed by geopandas
   - salib>=1.5
-  - seaborn>=0.13
-  - scikit-learn>=1.6
+  - scikit-learn>=1.7
   - scipy>=1.14,<1.15  # 1.15 is not compatible with climada_petals, climada_petals.engine.test.test_supplychain fails with "'Series' has no attribute 'nonzero'"
-  - sparse>=0.15
+  - seaborn>=0.13
+  - sparse>=0.17
   - statsmodels>=0.14
   - tabulate>=0.9
   - tqdm>=4.67
   - unittest-xml-reporting>=3.2
-  - xarray>=2025.1
+  - xarray>=2025.6
   - xlrd>=2.0
   - xlsxwriter>=3.2

script/jenkins/install_env.sh

@@ -5,7 +5,7 @@ mamba create -n climada_env python=3.11
 mamba env update -n climada_env -f requirements/env_climada.yml
 
 source activate climada_env
-python -m pip install -e "./[test]"
+python -m pip install -e "./[dev]"
 
 make install_test