aviary/pyproject.toml at main · CompRhys/aviary · 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
[project]
name = "aviary-models"
version = "1.2.1"
description = "A collection of machine learning models for materials discovery"
authors = [{ name = "Rhys Goodall", email = "rhys.goodall@outlook.com" }]
readme = "README.md"
license = { file = "LICENSE" }
keywords = [
  "Graph Neural Network",
  "Machine Learning",
  "Materials Discovery",
  "Materials Informatics",
  "Materials Science",
  "Roost",
  "Self-Attention",
  "Transformer",
  "Wren",
  "Wyckoff positions",
]
classifiers = [
  "Intended Audience :: Science/Research",
  "License :: OSI Approved :: MIT License",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Topic :: Scientific/Engineering :: Artificial Intelligence",
  "Topic :: Scientific/Engineering :: Chemistry",
  "Topic :: Scientific/Engineering :: Physics",
]

requires-python = ">=3.10"
dependencies = [
  "numpy>=2,<3",
  "pandas",
  "pymatgen>=2025.4.10",
  "scikit_learn",
  "tensorboard",
  "torch>=2.3.0",
  "tqdm",
  "typing-extensions",
  "wandb",
]

[project.urls]
Repo = "https://github.com/CompRhys/aviary"

[project.optional-dependencies]
test = ["matminer", "moyopy>=0.3.3", "pytest", "pytest-cov"]
moyopy = ["moyopy>=0.3.3"]

[build-system]
requires = ["uv_build>=0.7.5"]
build-backend = "uv_build"

[tool.uv.build-backend]
module-name = "aviary"
module-root = ""

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-p no:warnings"

[tool.mypy]
no_implicit_optional = false

[tool.ruff]
line-length = 90
target-version = "py310"
output-format = "concise"

[tool.ruff.lint]
select = [
  "B",    # flake8-bugbear
  "C4",   # flake8-comprehensions
  "D",    # pydocstyle
  "E",    # pycodestyle error
  "EXE",  # flake8-executable
  "F",    # pyflakes
  "FA",   # flake8-future-annotations
  "FLY",  # flynt
  "I",    # isort
  "ICN",  # flake8-import-conventions
  "ISC",  # flake8-implicit-str-concat
  "PD",   # pandas-vet
  "PERF", # perflint
  "PIE",  # flake8-pie
  "PL",   # pylint
  "PT",   # flake8-pytest-style
  "PYI",  # flakes8-pyi
  "Q",    # flake8-quotes
  "RET",  # flake8-return
  "RSE",  # flake8-raise
  "RUF",  # Ruff-specific rules
  "SIM",  # flake8-simplify
  "SLOT", # flake8-slots
  "TCH",  # flake8-type-checking
  "TID",  # tidy imports
  "TID",  # flake8-tidy-imports
  "UP",   # pyupgrade
  "W",    # pycodestyle warning
  "YTT",  # flake8-2020
]
ignore = [
  "C408",   # Unnecessary dict call - rewrite as a literal
  "D100",   # Missing docstring in public module
  "D104",   # Missing docstring in public package
  "D105",   # Missing docstring in magic method
  "D205",   # 1 blank line required between summary line and description
  "E731",   # Do not assign a lambda expression, use a def
  "ISC001",
  "PD901",  # pandas-df-variable-name
  "PLC0415",
  "PLR",    # pylint refactor
  "PT006",  # pytest-parametrize-names-wrong-type
]
pydocstyle.convention = "google"
isort.known-third-party = ["wandb"]

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["D"]
"examples/notebooks/*.py" = ["E402"]