pyrokinetics/pyproject.toml at unstable · ILexiconI/pyrokinetics · 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
[project]
name = "pyrokinetics"
description = "Python package for running and analysing gyrokinetic simulations"
readme = "README.md"
authors = [
    {name = "Bhavin Patel", email = "bhavin.s.patel@ukaea.uk"}
]
license = {file = "LICENSE"}
dynamic = ["version"]
keywords = ["gyrokinetics", "analysis", "plasma", "research"]
classifiers = [
    "Programming Language :: Python",
    "Development Status :: 3 - Alpha",
    "Natural Language :: English",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Scientific/Engineering :: Physics",
]

requires-python = ">=3.10"
dependencies = [
    "numpy >= 1.20.3, <= 2.1.0",
    "matplotlib >= 3.3.4",
    "f90nml >= 1.4.2",
    "scipy >= 1.10.1",
    "h5py >= 2.10",
    "netCDF4 >= 1.7.1",
    "path >= 15.1.2",
    "wheel >= 0.36",
    "freeqdsk ~= 0.5.0",
    "cleverdict >= 1.9.1",
    "xarray >= 2024.10.0, <=2024.11.0",
    "pint >= 0.23, <=0.24.4",
    "pint-xarray == 0.4",
    "contourpy ~= 1.0",
    "xrft >= 1.0.0",
    "idspy-dictionaries == 34000.2.0",
    "idspy-toolkit == 0.6.5",
    "pyloidal ~= 0.2.0",
    "xmltodict ~= 0.13.0",
    "typing-extensions >= 4.6.0",
    "simplejson >= 3.17.6",
    "jetto-tools >= 2.0.9",
    "periodictable",
    "toml",
    "sympy",
    "shapely",
]

[project.optional-dependencies]
docs = [
    "sphinx >= 5.3",
    "sphinx_autodoc_typehints >= 1.19",
    "sphinx-book-theme >= 0.4.0rc1",
    "myst_parser >= 0.14.0",
]
tests = [
    "pytest >= 3.3.0",
    "pytest-cov",
    "pyrokinetics-plugin-examples == 0.2.1",
]
linting = [
  "black",
  "isort",
  "flake8",
]

[project.urls]
Source = "https://github.com/pyro-kinetics/pyrokinetics"
Tracker = "https://github.com/pyro-kinetics/pyrokinetics/issues"
Documentation = "https://pyrokinetics.readthedocs.io/en/latest/"

[project.scripts]
pyro = "pyrokinetics.cli:entrypoint"

[build-system]
requires = [
    "setuptools >= 65",
    "setuptools-scm[toml]", # Used to manage package data, not for versioning
    "versioningit",
]
build-backend = "setuptools.build_meta"

[tool.versioningit]
vcs = { method = "git", default-tag = "v0.1.0" }
next-version = { method = "smallest" }

[tool.versioningit.write]
file = "src/pyrokinetics/_version.py"
template = """
__version__ = "{version}"
__version_tuple__ = {version_tuple}
__commit__ = "{revision}""""

# versioningit setup to mimic setuptools-scm versions
[tool.versioningit.format]
distance = "{next_version}.dev{distance}+{vcs}{rev}"
dirty = "{base_version}+d{build_date:%Y%m%d}"
distance-dirty = "{next_version}.dev{distance}+{vcs}{rev}.d{build_date:%Y%m%d}"

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.package-data]
pyrokinetics = ["templates/*"]

[tool.pytest.ini_options]
addopts = [
    "--import-mode=importlib",
]
filterwarnings = [
    "error::pint.UnitStrippedWarning",
  ]

[tool.coverage.run]
relative_files = true
omit = [
    "_version.py",
    "__main__.py",
    "__init__.py",
]

[tool.coverage.paths]
source = [
  "src/",
  "*/site-packages",
]

[tool.black]
exclude = "_version.py"

[tool.isort]
profile = "black"