pyproject.toml

[build-system]
requires = [
  "setuptools >= 61",
  "setuptools_scm[toml] >= 8",
]
build-backend = 'setuptools.build_meta'

[project]
name="NLR-rex"
dynamic = ["version"]
description = "National Laboratory of the Rockies' (NLR's) REsource eXtraction tool: rex"
readme = {file = "README.rst", content-type = "text/x-rst"}
authors = [
  {name = "Michael Rossol", email = "michael.rossol@nlr.gov"},
]
maintainers = [
  {name = "Grant Buster", email = "gbuster@nlr.gov"},
  {name = "Paul Pinchuk", email = "ppinchuk@nlr.gov"},
  {name = "Brandon Benton", email = "brandon.benton@nlr.gov"},
]
license = "BSD-3-Clause"
keywords = ["rex", "NLR"]
requires-python = ">= 3.9"
classifiers=[
  "Development Status :: 4 - Beta",
  "Intended Audience :: Science/Research",
  "Natural Language :: English",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
]
dependencies = [
  "click>=8.1.8",
  "fsspec>=2021.09.0",
  "dask>=2024.8.0",
  "h5py>=3.13.0",
  "h5pyd>=0.18.0",
  "numpy>=2.0.2",
  "pandas>=2.2.3,<3",
  "packaging>=24.2",
  "psutil>=7.0.0",
  "PyYAML>=6.0.2",
  "s3fs>=2023.6.0",
  "scikit-learn>=1.6.1",
  "scipy>=1.3",
  "toml>=0.10.2",
  "xarray>=2024.07.0",
]

[project.optional-dependencies]
test = [
  "pytest>=8.3.5,<9",
  "pytest-timeout>=2.3.1,<3",
  "flaky>=3.8.1,<4",
  "NREL-PySAM>=7.0.0",
]
dev = [
  "flake8",
  "pre-commit",
  "pylint",
]
hsds = [
  "hsds>=0.8.4",
]
build = [
  "build>=1.2.2,<2",
  "pkginfo>=1.12.1.2,<2",
  "twine>=6.1.0,<7",
]

[project.urls]
homepage = "https://www2.nrel.gov/gis/renewable-energy-potential"
documentation = "https://natlabrockies.github.io/rex/"
repository = "https://github.com/NatLabRockies/rex"

[project.scripts]
rex = "rex.resource_extraction.resource_cli:main"
NSRDBX = "rex.resource_extraction.nsrdb_cli:main"
WINDX = "rex.resource_extraction.wind_cli:main"
WaveX = "rex.resource_extraction.wave_cli:main"
MultiYearX = "rex.resource_extraction.multi_year_resource_cli:main"
US-wave = "rex.resource_extraction.US_wave_cli:main"
rechunk = "rex.rechunk_h5.rechunk_cli:main"
combine-h5 = "rex.rechunk_h5.combine_h5_cli:main"
temporal-stats = "rex.temporal_stats.temporal_stats_cli:main"
wind-rose = "rex.joint_pd.wind_rose_cli:main"

[project.entry-points."xarray.backends"]
rex = "rex.external.rexarray:RexBackendEntrypoint"


[tool.setuptools.packages]
find = { include = ["rex*"] }

[tool.setuptools.dynamic]
version = {attr = "rex.version.__version__"}

[tool.setuptools_scm]
# Don't try to guess anything from Git. Only use what is in the version file.
version_scheme = "no-guess-dev"
local_scheme = "no-local-version"


[tool.coverage.run]
branch = true

[tool.coverage.report]
# Regexes for lines to exclude from consideration
exclude_also = [
  # Have to re-enable the standard pragma
  "pragma: no cover",

  # Don't complain about missing debug-only code:
  "if self\\.debug",

  # Don't complain about repr methods
  "def __repr__",
  "def _repr_markdown_",

  # Don't complain about data I/O code
  "def load*",
  "def _load*",

  # Don't complain if tests don't hit defensive assertion code:
  "raise AssertionError",
  "raise NotImplementedError",

  # Don't complain if non-runnable code isn't run:
  "if __name__ == .__main__.:",

  # Don't complain about abstract methods, they aren't run:
  "@(abc\\.)?abstractmethod",

  # Don't complain about logging debugging functions
  "def print_logging_info*",
  "def __cls_name",
]

omit = [
  # omit test files
  "tests/*",
  # omit init files
  "__init__.py",
  # omit version file
  "version.py",
  # omit pixi files
  ".pixi/*",
]


[tool.pytest.ini_options]
addopts = "--disable-warnings"
testpaths = ["tests"]