pyproject.toml

[project]
name = "nsidc-iceflow"
version = "v0.2.0"
authors = [
  { name = "NSIDC", email = "nsidc@nsidc.org" },
]
description = "Harmonized access to (pre)OIB/IceSAT/IceSAT2 data"
readme = "README.md"
license.file = "LICENSE"
requires-python = ">=3.10"
classifiers = [
  "Development Status :: 1 - Planning",
  "Intended Audience :: Science/Research",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: MIT License",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Topic :: Scientific/Engineering",
  "Typing :: Typed",
]
dependencies = [
  "numpy >=2.0.1",
  "earthaccess >=0.10.0",
  "pandas >=2.2",
  "h5py >=3.11",
  "gps-timemachine >=1.1.4",
  "pyproj >=3.6.1",
  "shapely >=2.0.5",
  "pandera[mypy] >= 0.20.3",
  "pydantic >=2.8.2",
  "loguru >=0.7.2",
  "dask[dataframe] >=2024.10.0",
]

[project.urls]
Homepage = "https://github.com/NSIDC/iceflow"
"Bug Tracker" = "https://github.com/NSIDC/iceflow/issues"
Discussions = "https://github.com/NSIDC/iceflow/discussions"
Changelog = "https://github.com/NSIDC/iceflow/releases"

[project.optional-dependencies]
dev = [
  "bump-my-version",
  "invoke",
  "mypy >=1.11.1",
  "pandas-stubs >=2.2",
  "pre-commit",
  "pytest",
]
docs = [
  "sphinx>=7.0",
  "myst_parser>=0.13",
  "sphinx_copybutton",
  "sphinx_autodoc_typehints",
  "furo>=2023.08.17",
  "sphinx-autobuild",
  "myst-nb",
]
notebooks = [
  "jupyterlab",
  "matplotlib",
  "ipympl",
]


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

[tool.hatch.build.targets.wheel]
packages = ["src/nsidc"]


[tool.pytest.ini_options]
minversion = "6.0"
addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
xfail_strict = true
filterwarnings = [
  "error",
]
log_cli_level = "INFO"


[tool.coverage]
run.source = ["iceflow"]
report.exclude_also = [
  '\.\.\.',
  'if typing.TYPE_CHECKING:',
]

[tool.mypy]
files = ["src", "tests"]
python_version = "3.10"
warn_unused_configs = true
strict = true
enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
warn_unreachable = true
disallow_untyped_defs = false
disallow_untyped_calls = false
disallow_incomplete_defs = false
check_untyped_defs = true
plugins = "pandera.mypy"

# Needed to work with our namespaced package! See: https://mypy.readthedocs.io/en/stable/running_mypy.html#mapping-paths-to-modules
mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
explicit_package_bases = true

[[tool.mypy.overrides]]
module = [
  "iceflow.*",
  "shapely.*",
  "pyproj.*",
  "h5py.*",
  "numpy.*",
  "gps_timemachine.*",
  "dask.*",
  "dask.dataframe.*",
]
disallow_incomplete_defs = true
ignore_missing_imports = true


[tool.ruff]
src = ["src"]

[tool.ruff.lint]
extend-select = [
  "B",        # flake8-bugbear
  "I",        # isort
  "ARG",      # flake8-unused-arguments
  "C4",       # flake8-comprehensions
  "EM",       # flake8-errmsg
  "ICN",      # flake8-import-conventions
  "G",        # flake8-logging-format
  "PGH",      # pygrep-hooks
  "PIE",      # flake8-pie
  "PL",       # pylint
  "PT",       # flake8-pytest-style
  "PTH",      # flake8-use-pathlib
  "RET",      # flake8-return
  "RUF",      # Ruff-specific
  "SIM",      # flake8-simplify
  "T20",      # flake8-print
  "UP",       # pyupgrade
  "YTT",      # flake8-2020
  "EXE",      # flake8-executable
  "NPY",      # NumPy specific rules
  "PD",       # pandas-vet
]
ignore = [
  "PLR09",    # Too many <...>
  "PLR2004",  # Magic value used in comparison
  "ISC001",   # Conflicts with formatter
  "RET504",   # Unnecessary assignments before return statements are helpful during debugging.
  "PD901",    # Avoid using generic variable name `df` for dataframes.
  "EM101",    # Exceptions should not use string literals
  "SIM108",   # Use ternary operator. Sometimes this is less readable.
  "T201",     # Remove 'print' statements. Sometimes these are handy.
  "SIM105",   # Use contextlib.suppress instead of try-except-pass. The recommended approach is slower and less flexible.
  "RET505",   # Unnecessary else/elif: sometimes this is just more readable & explicit.
]
isort.required-imports = ["from __future__ import annotations"]
# Uncomment if using a _compat.typing backport
# typing-modules = ["iceflow._compat.typing"]

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["T20"]
"noxfile.py" = ["T20"]


[tool.pylint]
py-version = "3.10"
ignore-paths = [".*/_version.py"]
reports.output-format = "colorized"
similarities.ignore-imports = "yes"
messages_control.disable = [
  "design",
  "fixme",
  "line-too-long",
  "missing-module-docstring",
  "missing-function-docstring",
  "wrong-import-position",
]

[tool.bumpversion]
current_version = "0.2.0"
commit = false
tag = false

[[tool.bumpversion.files]]
filename = "src/nsidc/iceflow/__init__.py"
search   = '__version__ = "v{current_version}"'
replace  = '__version__ = "v{new_version}"'

[[tool.bumpversion.files]]
filename = "pyproject.toml"
search = 'version = "{current_version}"'
replace = 'version = "{new_version}"'

[tool.codespell]
skip="docs/iceflow-example.ipynb"