nrdk/pyproject.toml at main · RadarML/nrdk · 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
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "nrdk"
version = "0.2.1"
authors = [
  { name="Tianshu Huang", email="tianshu2@andrew.cmu.edu" },
]
description = "NRDK: Neural Radar Development Kit"
readme = "README.md"
requires-python = ">=3.12"
classifiers = [
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Typing :: Typed",
    "Operating System :: OS Independent"
]
license = "MIT"
license-files = ["LICEN[CS]E*"]

dependencies = [
    "abstract-dataloader >= 0.4.6",
    "pyyaml >= 5.0.0",
    "torch >= 2.4",
    "numpy >= 1.19",
    "beartype >= 0.20",
    "jaxtyping >= 0.3.2",
    "lightning == 2.5.5",
    "matplotlib >= 3.0.0",
    "torchvision",
    "einops >= 0.8.0",
    "optree >= 0.13",
    "tyro >= 0.9.0",
    "scipy >= 1.10.0",
    "scipy-stubs",
    "pandas >= 1.0.0",
    "pandas-stubs",
    "hydra-core >= 1.3.0",
    "rich >= 14.2.0"
]

[tool.uv.sources]
roverd = { git = "https://github.com/radarml/red-rover.git", subdirectory = "format"}

[project.optional-dependencies]
roverd = [
    "xwr >= 0.3.3",
    "roverd[ouster,video] >= 0.2.2"
]

docs = [
    # Most recent as of 16.04.2025; exact versions shouldn't matter unless the
    # API is changed, so we pin here just in case.
    "mkdocs == 1.6.*",
    "mkdocs-material == 9.6.*",
    "mkdocstrings-python-xref == 1.16.3",
    "mkdocstrings-python == 1.16.6",
    "griffe == 1.8.0",
    "mkdocstrings == 0.29.*",
    "ruff >= 0.10.0"
]
dev = [
    "pre-commit >= 4.0.0",
    "coverage",
    "pytest",
    "pytest-cov",
    "pyright >= 1.0.0",
    "ruff >= 0.10.0"
]

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

[tool.ruff.lint]
select = [
    "E", "F", "W", "N", "I", "D", "NPY"
]
ignore = [
    "D102",  # Inheriting docstrings is allowed
    "D107",  # Initializer goes in the class docstring
    "D401",  # "Imperative mood" NLP doesn't always make sense
    "D413",  # No blank lines after section is preferred by mkdocstrings
    "F722",  # Jaxtyping annotations confuse ruff
    "F821",
    "N806",  # We do math, so capitalization should be allowed

    # Must pick one...
    "D213",  # Pick 'multi-line-summary-first-line'.
    "D203",  # Pick `no-blank-line-before-class`.
]

[tool.coverage.report]
exclude_also = [
    '\.\.\.',
    'def __repr__',
    'if __name__ == .__main__.:',
    'class .*\bProtocol\):',
    'raise NotImplementedError',
]

[project.scripts]
tss = "nrdk:tss._cli_main"
nrdk = "nrdk:_cli.cli_main"