PyXC/pyproject.toml at main · polarities/PyXC · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
[project]
name = "pyxc"
version = "0.0.3"
description = "Python point-to-point correlation library."
readme = "README.md"
requires-python = ">=3.10"
license = {file = "LICENSE"}
authors = [
    {name = "Sang-Hyeok Lee"},
    {name = "Mattis Seehaus"},
]
maintainers = [
    {name = "Sang-Hyeok Lee"},
]
keywords = [
    "Point-to-point correlation"
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11"
]
dependencies = [
    'numpy >= 1.21.3; python_version == "3.10"',
    'numpy >= 1.23.2; python_version == "3.11"',
    "scipy",
    "tqdm",
]

[project.optional-dependencies]
development = [
    "pytest",
    "jupyter",
    "matplotlib       ==3.7.1",
    "nbsphinx         ==0.9.2",
    "numpydoc         ==1.5.0",
    "pandas           ==2.0.2",
    "pillow           ==9.5.0",
    "scikit-image     ==0.20.0",
    "sphinx-autoapi   ==2.1.1",
    "sphinx-rtd-theme ==1.3.0",
    "sphinx           ==7.0.1",
    "opencv-python    ==4.8.0.76",
]

[project.urls]
Homepage = "https://github.com/polarities/PyXC"
Documentation = "https://pyxc.readthedocs.org"
Repository = "https://github.com/polarities/PyXC.git"

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[tool.numpydoc_validation]
checks = [
    "GL01",
    "GL02",
    "GL03",
    "GL05",
    "GL06",
    "GL07",
    #"GL08",
    "SS01",
    "SS02",
    "SS03",
    "SS04",
    "SS05",
    "SS06",
    "PR01",
    "PR02",
    "PR03",
    "PR04",
    "PR05",
    "PR06",
    "PR07",
    "PR08",
    "PR09",
    "PR10",
]
exclude = [  # don't report on objects that match any of these regex
    '\.__repr__$',
]
override_SS05 = [  # override SS05 to allow docstrings starting with these words
    '^Process ',
    '^Assess ',
    '^Access ',
]