pyproject.toml

# -*- coding: utf-8 -*-

# AROSICS - Automated and Robust Open-Source Image Co-Registration Software
#
# Copyright (C) 2017–2026
# - Daniel Scheffler (GFZ Potsdam, daniel.scheffler@gfz.de)
# - GFZ Helmholtz Centre for Geosciences, Potsdam, Germany (https://www.gfz.de/)
#
# This software was developed within the context of the GeoMultiSens project funded
# by the German Federal Ministry of Education and Research
# (project grant code: 01 IS 14 010 A-C).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "arosics"
description = "An Automated and Robust Open-Source Image Co-Registration Software for Multi-Sensor Satellite Data"
authors = [{name = "Daniel Scheffler", email = "daniel.scheffler@gfz.de"}]
license = "Apache-2.0"
license-files = ["LICEN[CS]E*", "AUTHORS.rst"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering",
    "Natural Language :: English",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
]
keywords = [
    "arosics",
    "image co-registration",
    "geometric pre-processing",
    "remote sensing",
    "sensor fusion",
]
requires-python = ">=3.11"
dependencies = [
    "cartopy",
    "cmocean",
    "folium>=0.6.0,!=0.12.0",
    "gdal",
    "geoarray>=0.15.0",
    "geojson",
    "geopandas",
    "joblib>=1.3.0",
    "matplotlib",
    "numpy",
    "pandas",
    "plotly",
    "pyproj>2.2.0",
    "py_tools_ds>=0.23.2",
    "scikit-image>=0.21.0",
    "scipy>=1.7.0",
    "shapely",
]
dynamic = ["version"]

[project.readme]
file = "README.rst"
content-type = "text/x-rst"

[project.urls]
"Source code" = "https://git.gfz.de/danschef/arosics"
"Issue Tracker" = "https://git.gfz.de/danschef/arosics/-/issues"
"Documentation" = "https://danschef.git-pages.gfz-potsdam.de/arosics/doc/"
"Change log" = "https://git.gfz.de/danschef/arosics/-/blob/main/HISTORY.rst"
"Algorithm paper" = "https://www.mdpi.com/2072-4292/9/7/676"
"Zenodo" = "https://zenodo.org/record/5093940"

[project.optional-dependencies]
interactive_plotting = [
    "holoviews>1.12.7",
    "ipython",
    "nbformat",
]
interpolation = [
    "pykrige",
    "scikit-learn",
]
doc = [
    "sphinx-argparse",
    "sphinx_rtd_theme",
    "sphinx-autodoc-typehints",
]
test = [
    "pytest",
    "pytest-cov",
    "pytest-reporter-html1>=0.9.5",  # 0.9.4 misses constraint for docutils>=0.22"
    "urlchecker",
    "arosics[interactive_plotting]",
    "arosics[interpolation]",
]
lint = [
    "flake8",
    "pycodestyle",
    "pydocstyle",
]
dev = [
    "arosics[test]",
    "arosics[doc]",
    "arosics[lint]",
]

[project.scripts]
arosics = "arosics.arosics_cli:main"

[tool.hatch.version]
path = "arosics/version.py"

[tool.hatch.build.targets.wheel]
packages = ["arosics"]

[tool.hatch.build.targets.sdist]
exclude = [
    ".coveragerc",
    ".editorconfig",
    ".gitattributes",
    ".gitignore",
    ".gitlab-ci.yml",
    ".github/**",
    "docs/**",
    "tests/**",
    "__pycache__/**",
    "*.py[co]",
]

# make pytest import arosics from the source directory without installing it via pip
[tool.pytest.ini_options]
pythonpath = ["."]
testpaths = ["tests"]


# ==================
# Pixi configuration
# ==================

[tool.pixi.workspace]
channels = ["conda-forge"]
platforms = ["linux-64", "osx-arm64", "osx-64", "win-64"]

[tool.pixi.dependencies]
pip = "*"
python = ">=3.11"
cartopy = "*"
cmocean = "*"
folium = ">=0.6.0,!=0.12.0"
gdal = "*"
geoarray = ">=0.15.0"
geojson = "*"
geopandas = "*"
joblib = ">=1.3.0"
matplotlib = "*"
numpy = "*"
pandas = "*"
plotly = "*"
pyproj = ">2.2.0"
py-tools-ds = ">=0.23.2"
scikit-image = ">=0.21.0"
scipy = ">=1.7.0"
shapely = "*"

# -----------------------------
# Feature-specific dependencies
# -----------------------------

[tool.pixi.feature.test.dependencies]
pixi-pycharm = "*"
pytest = "*"
pytest-cov = "*"

[tool.pixi.feature.test.pypi-dependencies]
pytest-reporter-html1 = ">=0.9.5"  # 0.9.4 misses constraint for docutils>=0.22

[tool.pixi.feature.interactive-plotting.dependencies]
holoviews = ">1.12.7"
ipython = "*"
nbformat = "*"  # optional dependency of plotly

[tool.pixi.feature.interpolation.dependencies]
pykrige = "*"
scikit-learn = "*"

[tool.pixi.feature.doc.dependencies]
sphinx-argparse = "*"
sphinx-autodoc-typehints = "*"
sphinx_rtd_theme = "*"

[tool.pixi.feature.lint.dependencies]
flake8 = "*"
pycodestyle = "*"
pydocstyle = "*"
pylint = "*"

[tool.pixi.feature.urlcheck.dependencies]
lychee = "*"

[tool.pixi.feature.deploy.dependencies]
python-build = "*"
twine = "*"


# -----------------
# Pixi environments
# -----------------

[tool.pixi.environments]
default = []
interactive-plotting = { features = ["interactive-plotting"]}
interpolation = { features = ["interpolation"]}
test = { features = ["test", "interactive_plotting", "interpolation"]}
doc = { features = ["doc"], no-default-feature = true }
lint = { features = ["lint"], no-default-feature = true }
urlcheck = { features = ["urlcheck"], no-default-feature = true }
deploy = { features = ["deploy"], no-default-feature = true }
dev = { features = ["test", "interactive_plotting", "interpolation", "doc", "lint", "urlcheck", "deploy"]}

# -----
# Tasks
# -----

# Tasks available in every environment
[tool.pixi.tasks]
clean-build = "python _tasks.py clean-build"
clean-pyc = "python _tasks.py clean-pyc"
clean-test = "python _tasks.py clean-test"
clean = { depends-on = ["clean-build", "clean-pyc", "clean-test"] }
gitlab_ci_docker = """
    cd ./tests/CI_docker/ && \
    bash ./build_arosics_testsuite_image.sh
"""
install = { cmd = "pip install .", depends-on = ["clean"] }
create-env-info = "python _tasks.py create-env-info"

# Feature-specific tasks
[tool.pixi.feature.test.tasks]
test = "pytest"
pytest = "python _tasks.py pytest arosics"

[tool.pixi.feature.doc.tasks]
docs = "python _tasks.py docs arosics"

[tool.pixi.feature.lint.tasks]
lint = "python _tasks.py lint arosics"

[tool.pixi.feature.urlcheck.tasks]
urlcheck = "python _tasks.py urlcheck"

[tool.pixi.feature.deploy.tasks]
dist = { cmd = "python _tasks.py dist", depends-on = ["clean"] }
release = { cmd = "twine upload dist/*", depends-on = ["dist"] }