k-wave-python/pyproject.toml at master · waltsims/k-wave-python · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "k-Wave-python"
dynamic = ["version"]
description = "Acoustics toolbox for time domain acoustic and ultrasound simulations in complex and tissue-realistic media."
readme = "docs/README.md"
license = { file = "LICENSE" }
requires-python = ">=3.10"
authors = [
    { name = "Farid Yagubbayli", email = "farid.yagubbayli@tum.de" },
    { name = "Walter Simson", email = "walter.a.simson@gmail.com"}
]
maintainers = [
    { name = "Walter Simson", email = "walter.a.simson@gmail.com" },
    { name = "Farid Yagubbayli", email = "farid.yagubbayli@tum.de" },
    { name = "David Sinden", email = "david.sinden@mevis.fraunhofer.de" }
]
classifiers = [
    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
]
dependencies = [
    "h5py==3.16.0",
    "scipy==1.15.3",
    "opencv-python==4.13.0.92",
    "deepdiff==9.1.0",
    "numpy>=1.22.2,<2.3.0",
    "matplotlib==3.10.9",
    "beartype==0.22.9",
    "jaxtyping==0.3.7",
    "deprecated>=1.2.14",
    "tqdm>=4.60"
]

[project.urls]
Homepage = "http://www.k-wave.org/"
Documentation = "https://waltersimson.com/k-wave-python/"
Repository = "https://github.com/waltsims/k-wave-python"
Bug-tracker = "https://github.com/waltsims/k-wave-python/issues"

[project.optional-dependencies]
test = ["pytest",
        "pytest-xdist",
        "coverage==7.15.1",
        "phantominator",
        "testfixtures==8.3.0",
        "requests==2.34.2",
        "psutil>=5.9"]
example = ["gdown==6.1.0"]
benchmark = ["psutil>=5.9"]
docs = [ "sphinx<9",
    "sphinx-mdinclude==0.6.2",
    "sphinx-copybutton==0.5.2",
    "sphinx-tabs==3.4.5",
    "sphinx-toolbox==4.1.2",
    "furo==2025.12.19"]
dev = ["pre-commit==4.6.0"]

[tool.hatch.version]
path = "kwave/__init__.py"

[tool.hatch.metadata]

# can be removed as soon as uff is published and no longer a direct reference
allow-direct-references = true

[tool.hatch.build.targets.wheel]
packages = ["kwave", "kwave.utils", "kwave.reconstruction", "kwave.kWaveSimulation_helper"]


[tool.hatch.build.targets.sdist]
exclude = [
    "/.github",
    "/docs",
    "/examples",
    "/tests",
    "/kwave/bin/*",
    "*.mat",
]

[tool.pytest.ini_options]
testpaths = ["tests"]
markers = ["integration: MATLAB-reference integration tests (require collected values)"]
filterwarnings = [
    "error::DeprecationWarning",
    "error::PendingDeprecationWarning",
    "ignore::deprecation.DeprecatedWarning",
    "ignore::DeprecationWarning:kwave"
]

[tool.coverage.run]
branch = true
command_line = "-m pytest"
include = [
    "kwave/*",
    ]
omit = [
    # omit anything in a .local directory anywhere
    "tests/*",
    ]

[tool.ruff]
# Allow lines to be as long as 140 characters.
line-length = 140
# F821 needed to avoid false-positives in nested functions, F722 due to jaxtyping
lint.ignore = ["F821", "F722"]
lint.select = ["NPY201", "I"]

# Configure isort rules
[tool.ruff.lint.isort]
known-first-party = ["kwave", "examples"]
section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]

[tool.ruff.lint.per-file-ignores]
# ksource.py contains a lot of non-ported Matlab code that is not usable.
"kwave/ksource.py" = ["F821"]
# create_storage_variables.py references a few functions that are not ported yet.
"kwave/kWaveSimulation_helper/create_storage_variables.py" = ["F821"]
"kwave/kWaveSimulation_helper/__init__.py" = ["F401"]
"kwave/options/__init__.py" = ["F401"]
# Fix in the future => E731: Do not assign a `lambda` expression, use a `def`
"kwave/utils/mapgen.py" = ["E731"]

[dependency-groups]
dev = [
    "pytest-cov>=7.1.0",
]