virtualship/pyproject.toml at main · Parcels-code/virtualship · 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
137
138
139
140
141
142
143
144
145
146
147
148
149
[build-system]
requires = ["setuptools >= 61.0", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"

[project]
name = "virtualship"
description = "Code for the Virtual Ship Classroom, where Marine Scientists can combine Copernicus Marine Data with an OceanParcels ship to go on a virtual expedition."
readme = "README.md"
dynamic = ["version"]
authors = [{ name = "oceanparcels.org team" }]
requires-python = ">=3.10"
license = { file = "LICENSE" }
classifiers = [
    "Development Status :: 3 - Alpha",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Operating System :: OS Independent",
    "Topic :: Scientific/Engineering",
    "Topic :: Education",
    "Intended Audience :: Education",
]
dependencies = [
    "click",
    "parcels >3.1.0",
    "pyproj >= 3, < 4",
    "sortedcontainers == 2.4.0",
    "opensimplex == 0.4.5",
    "numpy >=1, < 2",
    "pydantic >=2, <3",
    "PyYAML",
    "copernicusmarine >= 2.2.2",
    "yaspin",
    "textual",
    "openpyxl",
]

[project.urls]
Homepage = "https://oceanparcels.org/" # TODO: Update this to just be repo?
Repository = "https://github.com/OceanParcels/virtualship"
Documentation = "https://virtualship.readthedocs.io/"
"Bug Tracker" = "https://github.com/OceanParcels/virtualship/issues"
Changelog = "https://github.com/OceanParcels/virtualship/releases"


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

[tool.setuptools.package-data]
virtualship = ["*.yaml"]

[tool.setuptools_scm]
version_file = "src/virtualship/_version_setup.py"
local_scheme = "no-local-version"

[project.scripts]
virtualship = "virtualship.cli.main:cli"


[tool.pytest.ini_options]
minversion = "6.0"
addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
xfail_strict = true
filterwarnings = [
  "error",
  "default::DeprecationWarning",
  "error::DeprecationWarning:virtualship",
  "ignore:ParticleSet is empty.*:RuntimeWarning" # TODO: Probably should be ignored in the source code
]
log_cli_level = "INFO"
testpaths = [
  "tests",
]


[tool.coverage]
run.source = ["virtualship"]
report.exclude_also = [
  '\.\.\.',
  'if typing.TYPE_CHECKING:',
]

[tool.ruff.lint]
exclude = ["*.ipynb"]

select = [
    "E",  # Error
    "F",  # pyflakes
    "I",  # isort
    "D", # pydocstyle
    "DOC", # pydoclint
    "B",  # Bugbear
    "UP", # pyupgrade
    "ICN", # import conventions
    "RUF", # ruff
    "ISC001", # single-line-implicit-string-concatenation
    "TID", # flake8-tidy-imports
]
ignore = [
    # line too long (82 > 79 characters)
    "E501",
    # consider `[meta, header, *data]` instead of concatenation
    "RUF005",
    # Use `X | Y` in `isinstance` call instead of `(X, Y)`
    "UP038",
    # multi-line-summary-first-line
    "D212",
    # one-blank-line-before-class
    "D203",
    # First line of docstring should be in imperative mood
    "D401",

    # TODO: Remove later
    "D100", "D103"
]


[tool.mypy]
files = ['src']
disable_error_code = "import-untyped"
check_untyped_defs = true
show_error_context = true
warn_redundant_casts = true
warn_unused_configs = true
warn_unused_ignores = true

exclude = [
  # Temporarily exclude files. As we improve typechecking across the codebase, remove these
  "src/virtualship/cli/_plan.py",
  "src/virtualship/cli/_run.py",
  "src/virtualship/cli/commands.py",
  "src/virtualship/cli/validator_utils.py",
  "src/virtualship/expedition/simulate_schedule.py",
  "src/virtualship/instruments/adcp.py",
  "src/virtualship/instruments/argo_float.py",
  "src/virtualship/instruments/base.py",
  "src/virtualship/instruments/ctd.py",
  "src/virtualship/instruments/drifter.py",
  "src/virtualship/instruments/ship_underwater_st.py",
  "src/virtualship/instruments/xbt.py",
  "src/virtualship/make_realistic/problems/simulator.py",
  "src/virtualship/models/checkpoint.py",
  "src/virtualship/models/expedition.py",
  "src/virtualship/utils.py",
]