pyproject.toml

[build-system]
requires = ["setuptools >= 61"]
build-backend = "setuptools.build_meta"

[project]
name = "newCAM_emulation"
version = "0.0.0"
description = "PyTorch Net to emulate the gravity wave drag in CAM"
authors = [
  { name="Qiang Sun", email="qiangsun@uchicago.edu" },
]
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.9"
classifiers = [
    "License :: OSI Approved :: MIT License",
    "Development Status :: 3 - Alpha",
    "Natural Language :: English",
    "Programming Language :: Python :: 3",
    'Programming Language :: Python :: 3.9',
    'Programming Language :: Python :: 3.10',
    'Programming Language :: Python :: 3.11',
    'Programming Language :: Python :: 3.12',
    'Typing :: Typed',
    "Operating System :: OS Independent",
]

dependencies = [
    "numpy>=1.20.0",
    "torch",
    "torchvision",
    "scipy",
    "matplotlib",
    "xarray",
    "netcdf4",
]
[project.optional-dependencies]
lint = [
    "ruff>=0.3.2",
]
pre-commit = [
    "pre-commit>=3.3.3",
]

[project.urls]
"Homepage" = "https://github.com/DataWaveProject/newCAM_emulation"
"Bug Tracker" = "https://github.com/DataWaveProject/newCAM_emulation/issues"

[tool.setuptools]
# By default, include-package-data is true in pyproject.toml, so you do
# NOT have to specify this line.
include-package-data = true

[tool.setuptools.packages.find]
where = ["."]  # list of folders that contain the packages (["."] by default)
include = ["newCAM_emulation*"]  # package names should match these glob patterns (["*"] by default)
exclude = ["Demodata/*"]  # exclude packages matching these glob patterns (empty by default)
namespaces = false  # to disable scanning PEP 420 namespaces (true by default)

[tool.ruff]
# Run linting and formatting on notebooks
extend-include = ["*.ipynb"]

[tool.ruff.lint]
# Enable:  D: `pydocstyle`, PL: `pylint`, I: `isort`, W: `pycodestyle whitespace`
#          NPY: `numpy`, 
select = ["D", "PL", "I", "E", "W", "NPY" ]

# Enable D417 (Missing argument description) on top of the NumPy convention.
extend-select = ["D417"]

[tool.ruff.lint.pydocstyle]
# Use NumPy convention for checking docstrings
convention = "numpy"