pyproject.toml

[build-system]
requires = ["setuptools>=61", "setuptools-scm>=8.0"]
build-backend = "setuptools.build_meta"

[project]
name = "erlab"
version = "3.1.1"
authors = [{ name = "Kimoon Han", email = "khan@kaist.ac.kr" }]
description = "Python package for ARPES data analysis and visualization."
readme = "README.md"
requires-python = ">=3.11"
keywords = ["Condensed Matter Physics", "ARPES"]
license = { file = "LICENSE" }
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Scientific/Engineering :: Visualization",
    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Operating System :: OS Independent",
]
dependencies = [
    # If you change anything here, also update environment.yml and docs/requirements.txt
    "h5netcdf>=1.2.0",
    "igor2>=0.5.9",
    "joblib>=1.3.2",
    "lmfit>=1.3.2",
    "matplotlib>=3.8.0",
    "numba>=0.59.0",
    "numpy>=1.26.0",
    "pyperclip>=1.8.2",
    "pyqtgraph>=0.13.1",
    "qtawesome>=1.3.1",
    "qtpy>=2.4.1",
    "scipy>=1.13.0",
    "tqdm>=4.66.2",
    "varname>=0.13.0",
    "xarray>=2024.10.0",
]

[project.optional-dependencies]
complete = ["erlab[viz,io,perf,misc]"]
viz = ["hvplot", "ipywidgets"]
io = ["astropy>=5.1.1", "nexusformat>=1.0.6"]
perf = ["numbagg>=0.8.1"]
misc = ["iminuit>=2.25.2", "csaps>=1.1.0", "dask>=2024.4.1"]
dev = [
    "mypy>=1.13.0",
    "pooch>=1.8.0",
    "pre-commit>=3.7.0",
    "pytest-cov>=5.0.0",
    "pytest-qt>=4.4.0",
    "pytest-datadir>=1.5.0",
    "pytest>=8.3.0",
    "commitizen>=3.29.0",
    "cz-changeup>=1.0.1",
    "ruff>=0.6.3",
]
docs = [
    "sphinx>=8.0.0",
    "sphinx-autodoc-typehints",
    "sphinx-copybutton",
    "sphinxcontrib-bibtex",
    "sphinx-qt-documentation",
    "sphinx-notfound-page",
    "pybtex",
    "nbsphinx",
    "myst-parser",
    "furo>=2024.07.18",
    "sphinx-design",
]

[project.scripts]
itool-manager = "erlab.interactive.imagetool.manager:main"

[project.urls]
Documentation = "https://erlabpy.readthedocs.io"
Repository = "https://github.com/kmnhan/erlabpy.git"
Issues = "https://github.com/kmnhan/erlabpy/issues"
Changelog = "https://github.com/kmnhan/erlabpy/blob/main/CHANGELOG.md"

[project.entry-points."xarray.backends"]
erlab-igor = "erlab.io.igor:IgorBackendEntrypoint"

[tool.commitizen]
change_type_map = { "BREAKING CHANGE" = "🚨 Breaking Changes", "feat" = "✨ Features", "fix" = "🐞 Bug Fixes", "perf" = "⚡️ Performance",  "refactor" = "🛠 Code Refactor" }

version_provider = "pep621"
update_changelog_on_bump = true
tag_format = "v$version"
changelog_start_rev = "v1.2.1"
changelog_merge_prerelease = true
name = 'cz_changeup'
change_type_order = [
    "🚨 Breaking Changes",
    "✨ Features",
    "🐞 Bug Fixes",
    "⚡️ Performance",
    "🛠 Code Refactor",
]
# cz-changeup configuration
changeup_repo_base_url = "https://github.com/kmnhan/erlabpy"
changeup_show_body = true
changeup_body_indent = 2
changeup_link_issues = true
changeup_scope_prefix = "**"
changeup_scope_suffix = ""
changeup_scope_separator = ":** "

[tool.setuptools]
package-dir = { "" = "src" }

[tool.setuptools_scm]

[tool.ruff]
line-length = 88
indent-width = 4

[tool.ruff.lint]
select = [
    "F",
    "E",
    "W",
    "I",
    "D",
    "UP",
    "YTT",
    "ASYNC",
    "B",
    "A",
    "C4",
    # "DTZ",
    "FA",
    "ICN",
    "LOG",
    "G",
    "PIE",
    "PYI",
    "PT",
    "Q",
    "RSE",
    "RET",
    "SIM",
    "TID",
    "TCH",
    "INT",
    # "ARG",
    # "PTH",
    # "FIX",
    # "PLC",
    # "PLE",
    # "PLW",
    "TRY",
    "FLY",
    "NPY",
    "PERF",
    "FURB",
    "RUF",
]
ignore = [
    "PLW2901", # Outer variable overwritten by inner target
    "ICN001",  # Import conventions
    "TRY003",  # Long exception messages
    "D100",    # Missing docstring in public module
    "D101",    # Missing docstring in public class
    "D102",    # Missing docstring in public method
    "D103",    # Missing docstring in public function
    "D104",    # Missing docstring in public package
    "D105",    # Missing docstring in magic method
]
extend-select = []
allowed-confusables = [
    "×",
    "−",
    "𝑎",
    "𝒂",
    "𝑏",
    "𝒃",
    "𝑐",
    "𝑥",
    "𝑦",
    "𝑧",
    "𝛼",
    "γ",
    "𝛾",
    "ν",
    "α",
]
exclude = ["*.ipynb"]

[tool.ruff.lint.pydocstyle]
convention = "numpy"

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"
docstring-code-format = true
docstring-code-line-length = "dynamic"

[tool.isort]
profile = "black"

[tool.pytest.ini_options]
addopts = ["--import-mode=importlib"]
pythonpath = "src"
testpaths = "tests"

[tool.coverage.run]
source = ["src"]
omit = ["*/_deprecated/*"]
concurrency = ["multiprocessing", "thread"]

[tool.coverage.report]
exclude_also = [
    "@numba.njit",
    "@cfunc",
    "get_ipython()",
    "from IPython",
    "def mouseDragEvent",
    "def .*_drag",
    "def _link_splitters",
    "def draw_mode",
    "QtWidgets.QApplication(sys.argv)",
    "QtWidgets.QMessageBox.question",
    "if not qapp:",
    "if execute is None:",
    "qapp.exec()",
    'if __name__ == "__main__:"',
    "except varname.VarnameRetrievingError:",
    "if TYPE_CHECKING:",
    "def _wrapped_for_coverage",
    "raise LookupError",
]

[tool.mypy]
plugins = ["numpy.typing.mypy_plugin"]
warn_unused_configs = true
warn_redundant_casts = true
warn_unused_ignores = true
allow_redefinition = true
check_untyped_defs = false
exclude = [
    '^docs/',
    '^tests/',
    '^build/',
    '_deprecated/',
    '^src/erlab/interactive/curvefittingtool.py',
]
disable_error_code = ['import-untyped']
pretty = true