braintools/pyproject.toml at main · chaobrain/braintools · 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
[build-system]
requires = ["setuptools>=64", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "braintools"
description = "Modeling tools for brain simulation."
readme = { file = "README.md", content-type = "text/markdown" }
license = { file = "LICENSE" }
requires-python = ">=3.11"
dynamic = ["version"]
authors = [
    { name = "BrainTools Developers", email = "chao.brain@qq.com" }
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Scientific/Engineering :: Bio-Informatics",
    "Topic :: Scientific/Engineering :: Mathematics",
    "Topic :: Software Development :: Libraries"
]
keywords = [
    "brain dynamics programming",
    "brain simulation",
    "brain-inspired computing",
    "brain-inspired computation",
    "brain modeling",
    "brain modeling toolbox",
]
dependencies = [
    "jax",
    "numpy>=1.15",
    "brainstate>=0.1.0",
    "brainunit>=0.0.8",
    "typing_extensions",
    "optax",
    "matplotlib",
    "msgpack",
    "scipy",
]

[project.optional-dependencies]
testing = [
    "pytest",
    "pytest-cov",
    "absl-py",
    "nevergrad",
    "tqdm",
    "rich",
]
type-check = [
    "mypy>=1.8",
]
cpu = [
    "jax[cpu]",
]
cuda12 = [
    "jax[cuda12]",
]
cuda13 = [
    "jax[cuda13]",
]
tpu = [
    "jax[tpu]",
]
cogtask = [
    "brainstate>=0.1.0",
    "brainunit>=0.0.8",
]
doc = [
    "pandoc",
    "Jinja2",
    "sphinx>=9.0.4",
    "myst-nb",
    "sphinx_thebe",
    "sphinx-autodoc-typehints",
    "sphinx-book-theme>=1.2.0",
    "sphinx-copybutton>=0.5.2",
    "sphinx-remove-toctrees",
    "jupyter-sphinx>=0.5.3",
    "sphinx-design",
    "sphinx_math_dollar",
    "brainx-sphinx-header>=0.4.0",
]

[project.urls]
homepage = "https://github.com/chaobrain/braintools"
repository = "https://github.com/chaobrain/braintools"
"Bug Tracker" = "https://github.com/chaobrain/braintools/issues"
Documentation = "https://brainx.chaobrain.com/braintools/"

[tool.setuptools.packages.find]
include = ["braintools*"]
exclude = [
    "docs*",
    "tests*",
    "dev*",
    "examples*",
    "build*",
    "dist*",
    "braintools.egg-info*"
]

[tool.setuptools.package-data]
# Ship the PEP 561 marker so type checkers consume braintools' inline types.
braintools = ["py.typed"]

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

[tool.coverage.run]
# `sysmon` uses CPython's sys.monitoring (3.12+); it is faster and avoids a
# native-tracer crash when jaxlib is imported under the C tracer.
core = "sysmon"
source = ["braintools"]
omit = [
    "*/_version.py",
    "*_test.py",
    # Optional/visual/hardware backends that cannot run in the standard CI
    # environment (their extra dependencies are not installed there):
    "*/visualize/_interactive.py",  # requires plotly
    "*/visualize/_three_d.py",      # requires pyvista
    "*/trainer/_distributed.py",    # requires a multi-device/multi-host setup
]

[tool.coverage.report]
show_missing = true
exclude_lines = [
    "pragma: no cover",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
    "@(abc\\.)?abstractmethod",
]

[tool.mypy]
python_version = "3.11"
# Many scientific dependencies (jax, brainunit, optax, scipy, ...) ship partial
# or no type information; don't fail on their missing stubs.
ignore_missing_imports = true
# Incremental typing: modules reached via import (third-party and internal code
# not yet annotated) are treated as untyped rather than reported. This keeps the
# explicitly type-checked public surface green while annotation coverage grows.
follow_imports = "skip"
warn_redundant_casts = true
warn_unused_ignores = false