particula-beta/pyproject.toml at main · uncscode/particula-beta · 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
[project]
name = "particula_beta"
description = "Development version of particula, containing new features and functionality."
readme = "readme.md"
requires-python = ">=3.9"
license = {file = "license"}
authors = [
    {name = "Gorkowski", email="Gorkowski@users.noreply.github.com"},
    {name = "ngam", email="ngam@users.noreply.github.com"},
]
classifiers = [
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "License :: OSI Approved :: MIT License",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering :: Atmospheric Science",
]
keywords = [
    "atmospheric", "particles", "climate", "aerosol", "particulate",
    "particula", "instruments", "optics", "scattering", "absorption",
    "new particle formation", "nucleation", "growth", "coagulation",
    "aerosol cloud interactions", "aerosol radiation interactions",
]

dependencies = [
    "particula","numpy>=2.0.0", "scipy>=1.12",
    "pint", "hypersolver==0.0.8", "pandas",
    "netCDF4", "shapely", "tqdm", "pytz",
    "matplotlib", "torch", "scikit-learn", "taichi", "pytest",
    "PyMieScatt @ git+https://github.com/bsumlin/PyMieScatt.git"
]

# This is set automatically by flit using `particula_beta.__version__`
dynamic = ["version"]

[project.urls]
homepage = "https://github.com/uncscode/particula-beta"
repository = "https://github.com/uncscode/particula-beta"

[project.optional-dependencies]
dev = [
    "pylint", "pytest", "autopep8", "jupyterlab",
    "typing", "build", "flake8", "jupyter-book", "ghp-import",
    "matplotlib", "pandas", "netCDF4", "shapely", "PyMieScatt",
    "tqdm", "pytz", "torch", "mkdocs-material", "handsdown",
    "mkdocs-jupyter", "black[jupyter]",
]

[build-system]
requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi"

# Configuration for ruff, a fast Python linter and formatter #
[tool.ruff]
line-length = 80
fix = true
extend-exclude = [
  "**/*.ipynb",    # ignore every .ipynb anywhere in the project
]

[tool.ruff.format]
docstring-code-line-length = 80

[tool.ruff.lint]
select = [
  "E", "F", "W", "C90", "D", "ANN", "B", "S", "N", "I"
]
ignore = [
  # choose one of the conflicting class-blank-line rules:
  "D203",  # or drop this and keep D211 instead
  "B008", # add back later
  "D205", # add back later
  "D102", # add back later
  "D107", # add back later
  "E501", # add back later
  # choose one of the conflicting multi-line-summary rules:
  "D213",  # or drop this and keep D212 instead
  "D417",  # Missing argument descriptions in the docstring :contentReference[oaicite:0]{index=0}
]
extend-ignore = [
  "ANN",    # ignore all missing-type-*/missing-return-type checks :contentReference[oaicite:1]{index=1}
]

[tool.ruff.lint.per-file-ignores]
# Ignore assert‐usage (S101) in any file ending with _test.py
"*_test.py" = ["S101", "E721", "B008"]

[tool.ruff.lint.pydocstyle]
# enforce Google-style sections and disable incompatible rules
convention = "google"          # accepts "google", "numpy", or "pep257"