pyproject.toml

[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "WAVES"
dynamic = ["version"]
authors = [{name = "Rob Hammond", email = "rob.hammond@nrel.gov"}]
readme = "README.md"
description = "Wind Asset Value Estimation System"
requires-python = ">=3.9, <3.11"
license = {file = "LICENSE"}
dependencies = [
    "tqdm",
    "attrs",
    "pyyaml",
    "matplotlib>=3.6",
    "numpy-financial>=1.0.0",
    "floris==3.6",  # TODO: upgrade to FLORIS v4
    "wombat>=0.9.3",
    "orbit-nrel>=1.0.8",
    "typer>=0.12.3",
]
keywords = [
    "python3",
    "wind-energy",
    "operations-maintenance",
    "operations-and-maintenance",
    "balance-of-system",
    "levelized-cost-of-energy",
    "lcoe",
    "aep",
    "wakes",
    "wake-analysis",
    "energy-production",
    "discrete-event-simulation",
    "simulation",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: Apache Software License",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Topic :: Scientific/Engineering",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Typing :: Typed",
]

[project.scripts]
waves = "waves.__main__:app"

[project.urls]
source = "https://github.com/NREL/WAVES"
documentation = "https://nrel.github.io/WAVES/"
issues = "https://github.com/NREL/WAVES/issues"
changelog = "https://github.com/NREL/WAVES/blob/main/CHANGELOG.md"

[project.optional-dependencies]
dev = [
    "pre-commit",
    "black",
    "isort",
    "pytest",
    "pytest-cov",
    "mypy",
    "ruff",
]
docs = [
    "jupyter-book",
    "myst-nb",
    "myst-parser",
    "sphinx-autodoc-typehints",
    "sphinxcontrib-autoyaml",
]
examples=[
    "jupyterlab",
    "jupyterlab-myst",
]
all = ["waves[dev,docs,examples]"]

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

[tool.setuptools.packages.find]
include = ["waves", "library", "*.yaml", "*.csv"]
exclude = [
    "*.tests",
    "*.tests.*",
    "tests.*",
    "tests",
    "*.results",
    "*.results.*",
    "results.*",
    "results",
]

[tool.setuptools.dynamic]
version = {attr = "waves.__version__"}

[tool.isort]
skip = [
  "waves/__init__.py",
]
multi_line_output = 3
sections = [
  "FUTURE",
  "STDLIB",
  "THIRDPARTY",
  "FIRSTPARTY",
  "LOCALFOLDER",
]
known_first_party = "waves"
known_local_folder = "tests"
combine_as_imports = true
force_grid_wrap = 0
include_trailing_comma = true
use_parentheses = true
length_sort = true
lines_after_imports = 2
line_length = 100


[tool.black]
target-version=["py310"]
line-length=100

include = '\.pyi?$'
exclude = '''
/(
    \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
)/
'''

[tool.ruff]
src = ["waves", "test"]
line-length = 100
target-version = "py310"
ignore-init-module-imports = true

# See https://github.com/charliermarsh/ruff#supported-rules
# for rules included and matching to prefix.
# TODO: "FBT", "B", "PIE, "T20", "SIM", "PTH", "PD", "I", "PL"
select = ["F", "E", "W", "C4", "D", "UP"]

# D205: not using summary lines and descriptions, just descriptions
# D401: don't believe enough in imperative mode to make all the changes currently
ignore = ["D205", "D401"]

# Allow autofix for all enabled rules (when `--fix`) is provided.
fixable = ["F", "E", "W", "C4", "D", "UP"]
unfixable = []

# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".hg",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
]

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.per-file-ignores]
"setup.py" = ["D104"]
"library/*/__init__.py" = ["D104"]
"library/*/cables/__init__.py" = ["D104"]
"library/*/project/__init__.py" = ["D104"]
"library/*/project/config/__init__.py" = ["D104"]
"library/*/project/plant/__init__.py" = ["D104"]
"library/*/project/port/__init__.py" = ["D104"]
"library/*/results/__init__.py" = ["D104"]
"library/*/substations/__init__.py" = ["D104"]
"library/*/substructures/__init__.py" = ["D104"]
"library/*/turbines/__init__.py" = ["D104"]
"library/*/vessels/__init__.py" = ["D104"]
"library/*/weather/__init__.py" = ["D104"]
"test/__init__.py" = ["D104"]
"test/library/__init__.py" = ["D104"]
"test/library/cables/__init__.py" = ["D104"]
"test/library/project/__init__.py" = ["D104"]
"test/library/project/config/__init__.py" = ["D104"]
"test/library/project/plant/__init__.py" = ["D104"]
"test/library/substations/__init__.py" = ["D104"]
"test/library/turbines/__init__.py" = ["D104"]
"test/library/vessels/__init__.py" = ["D104"]
"test/library/weather/__init__.py" = ["D104"]
"waves/__init__.py" = ["F401"]
"waves/utilities/__init__.py" = ["F401"]

[tool.ruff.pydocstyle]
convention = "numpy"