pyproject.toml

# (C) Copyright 2024 Anemoi contributors.
#
# This software is licensed under the terms of the Apache Licence Version 2.0
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
#
# In applying this licence, ECMWF does not waive the privileges and immunities
# granted to it by virtue of its status as an intergovernmental organisation
# nor does it submit to any jurisdiction.

[build-system]
requires = [ "setuptools>=60", "setuptools-scm>=8" ]

[project]
name = "anemoi-training"

description = "A package to hold various functions to support training of ML models."
keywords = [ "ai", "tools", "training" ]

license = { file = "LICENSE" }
authors = [
  { name = "European Centre for Medium-Range Weather Forecasts (ECMWF)", email = "software.support@ecmwf.int" },
]

requires-python = ">=3.9,<3.13" # Unable to use 3.13 until pyshtools updates

classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: Apache Software License",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
]

dynamic = [ "version" ]

dependencies = [
  "anemoi-datasets>=0.4",
  "anemoi-graphs>=0.4",
  "anemoi-models>=0.3",
  "anemoi-utils[provenance]>=0.4.4",
  "einops>=0.6.1",
  "hydra-core>=1.3",
  "matplotlib>=3.7.1",
  "mlflow>=2.11.1",
  "numpy<2",                         # Pinned until we can confirm it works with anemoi graphs
  "pynvml>=11.5",
  "pyshtools>=4.10.4",
  "pytorch-lightning>=2.1",
  "timm>=0.9.2",
  "torch>=2.2",
  "torch-geometric>=2.3.1,<2.5",
  "torchinfo>=1.8",
  "tqdm>=4.65",
  "zarr>=2.14.2",
]

optional-dependencies.all = [  ]

optional-dependencies.dev = [
  "anemoi-training[docs,tests,all]",
  "pre-commit>=3.3.3",
]

optional-dependencies.docs = [
  "nbsphinx",
  "pandoc",
  "sphinx",
  "sphinx-argparse",
  "sphinx-rtd-theme",
]
optional-dependencies.profile = [
  "holistictraceanalysis>=0.2",
  "pandas>=1.3.2",
  "rich>=13.6",
  "tabulate>=0.9",
]

optional-dependencies.tests = [ "hypothesis", "pytest", "pytest-mock" ]

urls.Changelog = "https://github.com/ecmwf/anemoi-training/CHANGELOG.md"
urls.Documentation = "https://anemoi-training.readthedocs.io/"
urls.Homepage = "https://github.com/ecmwf/anemoi-training/"
urls.Issues = "https://github.com/ecmwf/anemoi-training/issues"
urls.Repository = "https://github.com/ecmwf/anemoi-training/"
# command for interactive DDP (not supposed to be used directly)
# the dot is intentional, so it doesn't trigger autocomplete
# Files need to be named profiler due to A005 Module `profile` is shadowing a Python builtin module
scripts.".anemoi-training-profile" = "anemoi.training.commands.profiler:main"
scripts.".anemoi-training-train" = "anemoi.training.commands.train:main"
# Add subcommand in the `commands` directory
scripts.anemoi-training = "anemoi.training.__main__:main"

[tool.setuptools_scm]
version_file = "src/anemoi/training/_version.py"

[tool.ruff]
target-version = "py39"
line-length = 120
src = [ "src" ]
exclude = [ "docs/" ]

preview = true
lint.flake8-import-conventions.extend-aliases."pytorch_lightning" = "pl"
lint.pydocstyle.convention = "numpy"
select = [
  "A", # flake8 builtins
  # "ANN", # flake8-annotations
  "ANN001", # Type annotation
  "ANN201", # Return type public
  "ANN202", # Return type private
  "ANN205", # Return type static method
  "ANN206", # Return type class method
  "ARG",    # Unused arguments
  "B",      # flake8-bugbear
  "BLE",    # Non-specific exceptions
  "C4",     # Comprehensions
  "C90",    # Mccabe complexity
  "COM",    # Commas
  "CPY",    # Copyright
  # "C",  # pylint convention
  "D", # pydocstyle
  # "DOC", # pydoclint
  "DTZ", # Datetimes
  "E",   # pycodestyle error
  "EM",  # Error messages
  "ERA", # Found unused code
  "F",   # flake8 error
  "FA",  # Future annotations
  # "EXE", # Executable
  # "FBT", # Boolean traps
  "FLY",  # Fstrings
  "FURB", # Modernising code
  "G",    # flake8 logging format
  "ICN",  # Import conventions
  "ISC",  # Implicit string concatenation
  "LOG",  # Logging
  # "I", # isort
  "N",    # pep8 naming
  "NPY",  # Numpys
  "PERF", # Perfomance linting
  "PGH",  # Pygrep hooks
  "PIE",  # Misc lints
  # "PL",  # Pylint (superset of C, E, R, W)
  "PT",  # Pytest
  "PTH", # Use Pathlib
  "Q",   # Quotes
  "R",   # Refactor
  "RET", # Return statements
  "RSE", # Raises
  "RUF", # Ruff specific
  "S",   # bandit !IMPORTANT
  "SIM", # flake8-simplify
  "T10", # Debug statements
  "T20", # Print statements
  "TCH", # Type checking blocks
  "TD",  # Todos
  "TID", # Tidy imports
  "TRY", # Exception handling antipatterns
  "UP",  # Pyupgrade
  "W",   # pycodestyle warning
  "YTT", # flake8-2020
]

ignore = [
  "B018",
  "B028",
  "D100",
  "D101",
  "D102",
  "D103",
  "D104",
  "D105",
  "D401",
  "E203",
  "PT018",
  "S101",
  "TD003",
]