xFELTOR/pyproject.toml at main · feltor-dev/xFELTOR · 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
[project]
name = "xfeltor"
description = "Collect FELTOR simulation data into xarray"
authors = [
    {name = "Gregor Decristoforo", email = "gregor.decristoforo@uit.no"},
    {name = "Matthias Wiesenberger", email = "mattwi@fysik.dtu.dk"},
]
license = {file = "LICENSE"}
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
    "xarray >= 2025.3.1",
    "dask >= 2025.3.0",
    "natsort >= 8.4.0",
    "matplotlib >= 3.10.1",
    "animatplot >= 0.4.3",
    "netcdf4 >= 1.7.2",
    "Pillow >= 11.1.0",
]
classifiers =[
    "Intended Audience :: Science/Research",
    "Intended Audience :: Education",
    "Intended Audience :: Developers",
    "Natural Language :: English",
    "Operating System :: POSIX :: Linux",
    "Programming Language :: Python :: 3",
    "Topic :: Scientific/Engineering :: Visualization",
]
dynamic = ["version"]

[project.urls]
Source = "https://github.com/feltor-dev/xFELTOR"
Tracker = "https://github.com/feltor-dev/xFELTOR/issues"

# See setuptools info
# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
[build-system] # which build system to use
requires = [
    "setuptools >= 65", # build with setuptools
    "setuptools-scm >= 8.0.0", # for automatic version from git tags
]
build-backend = "setuptools.build_meta"
[tool.setuptools_scm]
# can be empty if no extra settings are needed, presence enables setuptools-scm

# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
[tool.setuptools.packages.find]
# We use the "flat" package layout
# https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#flat-layout
include = ["xfeltor"]


[project.optional-dependencies]
test = [
  "pytest",
]

# https://docs.astral.sh/ruff/
# pip install .[lint]
lint = [
  "ruff", # a python linter and formatter
]

docs = [
    "sphinx >= 5.3",
    "sphinx_autodoc_typehints >= 1.19",
    "sphinx-book-theme >= 0.4.0rc1",
    "myst_parser",
]
#calc = [
#    "numpy >= 1.21.1",
#    "scipy >= 1.7.2",
#    "dask >= 2021.8.1",
#]

[tool.ruff.lint]
select = [
    "F", # Pyflakes
    "E", # pycodestyle error
    "W", # pycodestyle warning
    "I", # isort
    "PT", # flake8-pytest-style
    "B", # flake8-bugbear
    "A", # flake8-builtins
    "C4", # flake8-comprehensions
    "T10", # flake8-debugger
    # "PTH", # flake8-use-pathlib
    "SIM", # flake8-simplify
    "TCH", # flake8-type-checking
    "UP", # pyupgrade
    "FURB", # refurb
    "PERF", # perflint
    "RUF", # ruff specific
    "NPY", # NumPy specific
]