pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "nonos"
version = "0.17.0"
description = "A tool to analyze results from idefix/pluto simulations (for protoplanetary disks more specifically)"
authors = [
    { name = "G. Wafflard-Fernandez" },
    { name = "C.M.T. Robert" },
]
classifiers = [
    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Typing :: Typed",
]
requires-python = ">=3.9"

dependencies = [
    "inifix>=3.0.0",
    "loguru>=0.5.3",
    "matplotlib>=3.5.0",
    "numpy>=1.19.3",
    "packaging>=20.0",
    "scipy>=1.6.1",
    "termcolor>=2.1.0",
    "tqdm>=4.64.1",
    "typing_extensions >= 4.4.0 ; python_version < '3.12'",
]

[project.optional-dependencies]
all = [
    "cblind>=2.3.0",
    "cmocean>=3.0.3",
    "cmyt>=2.0.0",
    "lick>=0.5.1",
]

[project.license]
text = "GPL-3.0"

[project.readme]
file = "README.md"
content-type = "text/markdown"

[project.scripts]
nonos = "nonos.main:main"

[project.urls]
Homepage = "https://github.com/volodia99/nonos"

[dependency-groups]
test = [
    "cogapp>=3.3.0",
    "pytest-mpl>=0.15.1",
    "pytest>=7.0.0",

]
covcheck = [
    {include-group = "test"},
    "coverage[toml]>=7.4.4 ; python_full_version < '3.11'",
    "coverage>=7.4.4 ; python_full_version >= '3.11'",
]
typecheck = [
    "matplotlib>=3.8.0",
    "mypy>=1.13.0",
]
docs = [
    "mkdocs>=1.6.1",
    "mkdocs-include-markdown-plugin>=7.1.2",
    "mkdocs-material>=9.5.47",
    "mkdocstrings[python]>=0.27.0",
]

[tool.hatch.build.targets.sdist]
exclude = [
    "tests",
    ".github",
    "docs",
    "mkdocs.yml",
    "_typos.toml",
    ".readthedocs.yaml",
    ".pre-commit-config.yaml",
    ".gitignore",
]

[tool.ruff.lint]
exclude = [
    "*__init__.py",
    "from_simulation.py", # deprecated module
]
ignore = [
    "E501",
    "PTH123", # `open()` should be replaced by `Path.open()`
]
select = [
    "E",
    "F",
    "W",
    "ARG", # flake8-unused-arguments
    "C4",  # flake8-comprehensions
    "PTH", # flake8-use-pathlib
    "B",   # flake8-bugbear
    "YTT", # flake8-2020
    "I",   # isort
    "UP",  # pyupgrade
]

[tool.ruff.lint.isort]
combine-as-imports = true

[tool.pytest.ini_options]
addopts = "-ra"
filterwarnings = [
    "error",
    'ignore:datetime\.datetime\.utcfromtimestamp\(\) is deprecated:DeprecationWarning', # https://github.com/dateutil/dateutil/pull/1285
    'ignore:The py23 module has been deprecated and will be removed in a future release:DeprecationWarning',
    "ignore:Passing 'N' to ListedColormap is deprecated since:DeprecationWarning", # https://github.com/matplotlib/cmocean/pull/114
]

[tool.mypy]
# python_version = "3.9" # this can be uncommented (and updated) when Python 3.9 is dropped
show_error_codes = true
warn_unused_configs = true
# warn_unused_ignores = true # this can be uncommented (and updated) when Python 3.9 is dropped
warn_unreachable = true
show_error_context = true
disallow_untyped_defs = false  # TODO: add missing annotations and switch this option to true
ignore_missing_imports = true

[tool.coverage.run]
source = [
    "nonos",
    "tests",
]
omit = [
    "nonos/_backports.py",
    "nonos/__main__.py",
    "nonos/api/from_simulation.py", # deprecated module
]

[tool.coverage.report]
skip_covered = true
exclude_lines = [
    # a stricter default pragma
    "\\# pragma: no cover\\b",

    # allow defensive code
    "^\\s*raise NotImplementedError\\b",
    "^\\s*assert_never\\b",

    # typing-related code
    "^if TYPE_CHECKING:",
    ": \\.\\.\\.(\\s*#.*)?$",
    "^ +\\.\\.\\.$",
    "-> ['\"]?NoReturn['\"]?:",
]