PyFV3/pyproject.toml at develop · jjuyeonkim/PyFV3 · 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
[build-system]
build-backend = "setuptools.build_meta"
requires = ["setuptools >= 77.0.3"]

[project]
authors = [{name = "NOAA - Geophysical Fluid Dynamics Laboratory", email = "oliver.elbert@noaa.gov"}]
classifiers = [
  "Development Status :: 2 - Pre-Alpha",
  "Intended Audience :: Developers",
  "Natural Language :: English",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.11"
]
dependencies = [
  "dacite",
  "f90nml>=1.1.0",
  "numpy==1.26.4",
  "pyyaml",
  "xarray"
]
description = "PyFV3 is a NDSL-based FV3 dynamical core for atmospheric models."
license = "Apache-2.0"
license-files = ["LICENSE.md"]
name = "pyfv3"
readme = "README.md"
requires-python = ">=3.11,<3.12"
version = "0.2.0"

[project.optional-dependencies]
dev = [
  "pyfv3[docs,ndsl,test]",
  "pre-commit",
  "flake8-pyproject"
]
docs = [
  "mkdocs-material",
  "mkdocstrings[python]"
]
extras = [
  "pyfv3[dev]",
  "pyfv3[docs]",
  "pyfv3[ndsl]",
  "pyfv3[test]"
]
ndsl = ["ndsl @ git+https://github.com/NOAA-GFDL/NDSL.git@2026.01.00"]
test = [
  "coverage",
  "pytest",
  "pytest-subtests",
  "serialbox"
]

[project.urls]
Repository = "https://github.com/NOAA-GFDL/pyFV3"

[tool.aliases]

[tool.black]
line-length = 88
target_version = ['py311']

[tool.coverage.run]
branch = true
omit = ["tests/*", "*gt_cache*", ".dacecache*", "external/*", "__init__.py"]
parallel = true
source_pkgs = ["pyfv3"]

[tool.flake8]
exclude = ["docs"]
extend-ignore = ["W503", "E302", "E203", "F841", "E501"]
max-line-length = 88

[tool.isort]
default_section = "THIRDPARTY"
force_grid_wrap = 0
include_trailing_comma = true
known_first_party = "pyfv3,ndsl,pyshield"
known_third_party = "f90nml,pytest,xarray,numpy,mpi4py,gt4py"
line_length = 88
lines_after_imports = 2
multi_line_output = 3
sections = "FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER"
use_parentheses = true

[tool.mypy]
disallow_incomplete_defs = true
disallow_untyped_defs = true
# TODO: understand what's wrong with imports and fix
ignore_missing_imports = true
strict_equality = true
strict_optional = true
warn_redundant_casts = true
warn_unreachable = true
warn_unused_configs = true
warn_unused_ignores = true

[[tool.mypy.overrides]]
disallow_incomplete_defs = false
disallow_untyped_defs = false
module = [
  # not sure if we can ever type all stencils
  "pyfv3.stencils.*",
  "pyfv3.initialization.test_cases.*",
  "pyfv3.initialization.init_utils",
  "pyfv3.testing.validation"
]

[tool.setuptools]
include-package-data = true

[tool.setuptools.packages.find]
include = ["pyfv3", "pyfv3.*"]