pyproject.toml

[build-system]
requires = ["setuptools >= 40.6.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "floris"
version = "4.2.2"
description = "A controls-oriented engineering wake model."
readme = "README.md"
requires-python = ">=3.9"
authors = [
    { name = "Rafael Mudafort", email = "rafael.mudafort@nrel.gov" },
    { name = "Paul Fleming", email = "paul.fleming@nrel.gov" },
    { name = "Michael (Misha) Sinner", email = "Michael.Sinner@nrel.gov" },
    { name = "Eric Simley", email = "Eric.Simley@nrel.gov" },
    { name = "Christopher Bay", email = "Christopher.Bay@nrel.gov" },
]
license = { file = "LICENSE.txt" }
keywords = ["floris"]
classifiers = [
        "License :: OSI Approved :: BSD License",
        "Programming Language :: Python",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Programming Language :: Python :: 3.13",
        "Programming Language :: Python :: Implementation :: CPython",
        "Programming Language :: Python :: Implementation :: PyPy"
]
dependencies = [
    "attrs",
    "pyyaml~=6.0",
    "numexpr~=2.0",
    "numpy~=1.20",
    "scipy~=1.1",
    "matplotlib~=3.0",
    "pandas~=2.0",
    "shapely~=2.0",
    "coloredlogs~=15.0",
    "pathos~=0.3",
]

[project.optional-dependencies]
docs = [
    "jupyter-book~=1.0",
    "sphinx-book-theme~=1.0",
    "sphinx-autodoc-typehints~=2.0",
    "sphinxcontrib-autoyaml~=1.0",
    "sphinxcontrib.mermaid~=1.0",
]
develop = [
    "pytest~=8.0",
    "pre-commit~=4.0",
    "ruff~=0.7",
    "isort~=5.0"
]

[tool.setuptools.packages.find]
include = ["floris*"]

[tool.setuptools.package-data]
floris = [
    "turbine_library/*.yaml",
    "core/wake_velocity/turbopark_lookup_table.mat"
]

[project.urls]
Homepage = "https://github.com/NREL/floris"
Documentation = "https://nrel.github.io/floris/"

[coverage.run]
# Coverage.py configuration file
# https://coverage.readthedocs.io/en/latest/config.html
branch = true
source = "floris/*"
omit = [
    "setup.py",
    "tests/*"
]


[tool.pytest.ini_options]
testpaths = "tests"
filterwarnings = [
    "ignore::DeprecationWarning:pandas.*:"
]



## Pyflakes (F)
## pycodestyle (E, W)
# mccabe (C90)
# isort (I)     # Use isort directly until more isort features are included in ruff
# pep8-naming (N)
# pydocstyle (D)
# pyupgrade (UP)
# flake8-2020 (YTT)
# flake8-annotations (ANN)
# flake8-bandit (S)
# flake8-blind-except (BLE)
# flake8-boolean-trap (FBT)
# flake8-bugbear (B)
# flake8-builtins (A)
# flake8-commas (COM)
# flake8-comprehensions (C4)
# flake8-datetimez (DTZ)
# flake8-debugger (T10)
# flake8-errmsg (EM)
# flake8-executable (EXE)
# flake8-implicit-str-concat (ISC)
# flake8-import-conventions (ICN)
# flake8-logging-format (G)
# flake8-no-pep420 (INP)
# flake8-pie (PIE)
# flake8-print (T20)
# flake8-pytest-style (PT)
# flake8-quotes (Q)
# flake8-return (RET)
# flake8-simplify (SIM)
# flake8-tidy-imports (TID)
# flake8-type-checking (TCH)
# flake8-unused-arguments (ARG)
# flake8-use-pathlib (PTH)
# eradicate (ERA)
# pandas-vet (PD)
# pygrep-hooks (PGH)
# Pylint (PL)
# - Convention (PLC)
# - Error (PLE)
# - Refactor (PLR)
# - Warning (PLW)
# tryceratops (TRY)
# flake8-raise (RSE)
# flake8-self (SLF)
# Ruff-specific rules (RUF)

[tool.ruff]
src = ["floris", "tests"]
line-length = 100
target-version = "py310"

# See https://github.com/charliermarsh/ruff#supported-rules
# for rules included and matching to prefix.
select = ["F", "E", "W", "C4", ] #"T20", "I"
# I - isort is not fully implemented in ruff so there is not parity. Consider disabling I.

# F401 unused-import: Ignore until all used isort flags are adopted in ruff
ignore = ["F401"]

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

# Exclude a variety of commonly ignored directories.
exclude = [
    "floris/version.py",
    ".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]
# F841 unused-variable: ignore since this file uses numexpr and many variables look unused
"floris/core/wake_deflection/jimenez.py" = ["F841"]
"floris/core/wake_turbulence/crespo_hernandez.py" = ["F841"]
"floris/core/wake_deflection/gauss.py" = ["F841"]
"floris/core/wake_velocity/jensen.py" = ["F841"]
"floris/core/wake_velocity/gauss.py" = ["F841"]
"floris/core/wake_velocity/empirical_gauss.py" = ["F841"]
# Ignore `F401` (import violations) in all `__init__.py` files, and in `path/to/file.py`.
"__init__.py" = ["F401"]

# I001 unsorted-imports: ignore because the import order is meaningful to navigate
# import dependencies
"floris/core/__init__.py" = ["I001"]

[tool.ruff.isort]
combine-as-imports = true
known-first-party = ["floris"]
order-by-type = false
# lines-after-imports = 2

# [tool.ruff.mccabe]
# # Unlike Flake8, default to a complexity level of 10.
# max-complexity = 10


[tool.isort]
sections = [
    "FUTURE",
    "STDLIB",
    "THIRDPARTY",
    "FIRSTPARTY",
    "LOCALFOLDER"
]
known_first_party = [
    "floris"
]
multi_line_output = 3
combine_as_imports = true
force_grid_wrap = 3
include_trailing_comma = true
use_parentheses = true
lines_after_imports = 2
line_length = 100
order_by_type = false
split_on_trailing_comma = true

# length_sort = true
# case_sensitive: False
# force_sort_within_sections: True
# reverse_relative: True
# sort_relative_in_force_sorted_sections: True