pyproject.toml

[project]
name = "bluemira"
authors = [{ name = "The bluemira team" }]
description = """An integrated inter-disciplinary design tool for future fusion
 reactors, incorporating several modules, some of which rely on
 other codes, to carry out a range of typical conceptual fusion
 reactor design activities."""
readme = "README.md"
requires-python = ">=3.10"
dynamic = ['version']
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: GNU Lesser General Public License v2.1 or later (LGPLv2.1+)",
    "Operating System :: POSIX :: Linux",
]
dependencies = [
    "anytree",
    "asteval",
    "Babel",
    "click",
    "contourpy",
    "CoolProp",
    "eqdsk>=0.4.0, <0.5.0",
    "fortranformat",
    "gmsh",
    "imageio",
    "matplotlib>=3.8",
    "meshio",
    "neutronics-material-maker>=1.1.4",
    "nlopt",
    "numba",
    "numba-scipy",
    "numpy",
    "pint",
    "periodictable",
    "pyclipper",
    "pypet",
    "pyvista",
    "rich",
    "scikit-learn",
    "seaborn",
    "tables",
    "tabulate",
    "typeguard >3.0.0",
    "scipy",
]

[project.entry-points.numba_extensions]
init = "numba_scipy:_init_extension"

[project.urls]
homepage = "https://github.com/Fusion-Power-Plant-Framework/bluemira"
documentation = "https://bluemira.readthedocs.io"
repository = "https://github.com/Fusion-Power-Plant-Framework/bluemira"

[project.optional-dependencies]
dev = [
    "jupytext",
    "mypy",
    "myst-nb != 1.1.2",
    "pre-commit",
    "pytest",
    "pytest-cov",
    "pytest-html",
    "pytest-metadata",
    "pytest-json-report",
    "ruff==0.7.0",
    "sphinx",
    "sphinx-autoapi",
    "sphinx_copybutton",
    "sphinx-rtd-theme>=2.0.0",
    "sybil",
]
examples = ["notebook", "jupytext"]
pinned = [
    "nlopt==2.7.1",
    "numba==0.60.0",
    "numba-scipy==0.4.0",
    "numpy==1.26.4",
    "matplotlib==3.9.2",
    "scipy==1.10.1",
    "vtk==9.2.6",  # needed for uv resolution
]

conda_pinned = ["fenics-dolfinx==0.7.3", "freecad==0.21.2"]
openmc = ["openmc>=0.14.0", "openmc_data==2.2.10"]
process = ["process==3.1.0"]
polyscope = ["polyscope"]
radiation = ["cherab"]

[build-system]
requires = ["setuptools>=62", "setuptools_scm[toml]>=7.0"]

[tool.setuptools.packages.find]
where = ["."]
include = ["bluemira*"]
exclude = ["tests*"]

[tool.setuptools_scm]

[tool.coverage.report]
"exclude_also" = [
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
    "@nb"  # awaiting https://github.com/numba/numba/issues/4268
]

[tool.mypy]
python_version = "3.10"
check_untyped_defs = true
disallow_any_generics = true
disallow_incomplete_defs = true
disallow_subclassing_any = true
disallow_untyped_calls = true
disallow_untyped_decorators = true
disallow_untyped_defs = false
extra_checks = true
ignore_missing_imports = true
no_implicit_reexport = true
strict_equality = true
warn_no_return = false
warn_redundant_casts = true
warn_return_any = false
warn_unused_configs = true
warn_unused_ignores = true

[tool.pytest.ini_options]
markers = [
    "longrun: Long running tests (>20s)",
    "reactor: Whole reactor tests",
    "private: Tests using private data",
    "classplot: Show and close figures after running all tests in class",
]
addopts = "--html=report.html --self-contained-html --strict-markers -r fEX"
filterwarnings = ['ignore:Matplotlib is currently using agg:UserWarning',
                  'ignore:FigureCanvasAgg is non-interactive:UserWarning']
pythonpath = ['.', 'eudemo']

[tool.ruff]
target-version = "py310"
line-length = 89
output-format= "concise"
exclude = [
    ".git",
    "__pycache__",
    "documentation",
    ".env",
    ".idea",
    ".pytest_cache",
    "htmlcov",
    "generated_data",
]

[tool.ruff.format]
preview = true

[tool.ruff.lint]
preview = true
select = ["ALL"]
ignore = [
    "ANN",     # type annotations
    "EM",      # string in error messages
    "PD",      # Pandas
    "B019",    # using cache memory leaks
    "COM812",  # enforce trailing comma, disagrees with black/ruff format
    "D200",    # docs stuff
    "D203",
    "D205",
    "D301",
    "D400",
    "D401",
    "DOC502",  # Omit non-explicit exceptions from docstrings
    "DTZ005",  # datetime timezone arg
    "E203",    # black/ruff format conflicts
    "FIX002",  # Line contains todo
    "ISC001",  # ruff format conflict
    "PLW1514", # Specify file open encoding
    "PTH123",  # use Path.open
    "TRY003",  # put error messages in error class
    "FURB152",  # 3.14 != pi
    "PIE790",  # TMP for false positive ...
    # should remove
    # "TD",  # standardise TODOs
    "ERA",  # remove commented out code
    "SLF001",  # private method use

]

[tool.ruff.lint.isort]
case-sensitive = true
known-first-party = ["bluemira", "eudemo", "eudemo_tests"]
force-to-top = ["freecad", "FreeCAD"]

[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "all"

[tool.ruff.lint.mccabe]
max-complexity = 20

[tool.ruff.lint.pylint]
# These should be made stricter
max-args = 30
max-statements = 73
max-returns = 12
max-branches = 23
max-public-methods = 38
max-bool-expr = 6
max-locals = 48
max-nested-blocks = 7

[tool.ruff.lint.flake8-bugbear]
extend-immutable-calls = [
    "bluemira.base.reactor.FilterMaterial",
    "bluemira.utilities.opt_variables.ov",
    "bluemira.utilities.tools.ColourDescriptor",
]

[tool.ruff.lint.flake8-copyright]
notice-rgx = "(?i)# SPDX-FileCopyrightText:\\s\\d{4}(-(\\d{4}|present))*"

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

[tool.ruff.lint.pycodestyle]
max-doc-length = 89

[tool.ruff.lint.pep8-naming]
ignore-names = [
    "*PROCESS*",
    "*PLASMOD*",
    "*NAME*",
    "*BINARY*",
    "*CAD*",
    "*STP*",
    "*STL*",
    "*0D*",
    "*1D*",
    "*2D*",
    "*3D*",
    "*4D*",
    "*5D*",
    "BB",
    "*VV*",
    "*TS*",
    "RS",
    "*FW*",
    "CR",
    "EQ",
    "DIV",
    "*RM*",
    "*HCD*",
    "NB",
    "EC",
    "*IVC*",
    "*TF*",
    "*PF*",
    "*CS*",
    "*GS*",
    "*TFV*",
    "*TBR*",
    "*LCFS*",
    "*OIS*",
    "*JT60SA*",
    "*ITER*",
    "princetonD",
    "flatD",
    "negativeD",
    "negativeflatD",
    "R_0",
    "Z_0",
    "B_0",
    "I_p",
    "Ip",
    "A",
    "F",
    "Z_eff",
    "T_e*",
    "B*",
    "*B_*",
    "*Bt*",
    "*Bx*",
    "*Bz*",
    "*Bp*",
    "*Fz*",
    "*m_T*",
    "*DD*",
    "*DT*",
    "*SN*",
    "*DN*",
    "*CREATE*",
    "Psol_near",
    "Psol_far",
    "*Class",
    "*L_to_xz*",
    "*xz_to_L*",
    "*to_L*",
    "*L_to_zdz*",
    "get_Lmap",
    "set_Lmap",
    "*LFS*",
    "*HFS*",
    "*_OX_*",
    "*_F",
    "*eV",
    "I_not_dI",
    "*Li*"
]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401", "F403"]
"bluemira/__init__.py" = ["TID252"]
"bluemira/codes/__init__.py" = ["E402"]
"bluemira/codes/process/model_mapping.py" = ["PLR6301"]
"bluemira/geometry/parameterisations.py" = ["E731"]
"bluemira/codes/plasmod/api/{_inputs,_outputs}.py" = ["N815"]
"data/*" = ["INP001"]
"scripts/*" = ["INP001", "CPY001", "T201"]
"setup.py" = ["CPY001"]
"documentation/source/*" = ["D100", "D101"]
"examples/*" = ["INP001", "T201", "DOC201"]
"examples/geometry/optimisation_tutorial.ex.py" = ["W505", "E501"]
"examples/optimisation/geometry_optimisation.ex.py" = ["E402"]
"examples/optimisation/nonlinearly_constrained_problem.ex.py" = ["E402", "W505"]
"eudemo/eudemo/reactor.py" = ["ARG001"]
"bluemira/codes/plasmod/mapping.py" = ["TD"]
"bluemira/balance_of_plant/calculations.py" = ["TD"]
"{tests,eudemo/eudemo_tests}/*" = [
    "INP001",
    "PLR2004",
    "PLR6301",
    "PLR0904",
    "PLC1901",
    "S101",
    "F841",
    "D100",
    "D101",
    "D102",
    "D103",
    "D104",
    "D105",
    "D202",
    "D205",
    "D210",
    "D300",
    "D301",
    "D401",
    "D403",
    "D404",
    "D406",
    "D409",
    "DOC201",
    "DOC501",
    "N802",
    "PLC2701",
    "PT023",
    "T201",
]
"tests/codes/plasmod/test_profiles.py" = ["E221", "E501"]
"tests/geometry/test_private_tools.py" = ["E501"]
"tests/utilities/test_opt_variables.py" = ["E501"]
# TODO remove
"eudemo/eudemo/*" = ["DOC201", "TD"]  #186
# see above for actual line
# "examples/*" = ["DOC201"]  # 51
"bluemira/utilities/*" = ["DOC201"]  # 38
"bluemira/structural/*" = ["DOC201"]  # 29
"bluemira/radiation_transport/*" = ["DOC201"]  # 103
"bluemira/plasma_physics/*" = ["DOC201"]  # 4
"bluemira/optimisation/*" = ["DOC201"]  # 24
"bluemira/mesh/*" = ["DOC201"]  # 10
"bluemira/materials/*" = ["DOC201"]  # 62
"bluemira/magnetostatics/*" = ["DOC201"]  # 45
"bluemira/geometry/*" = ["DOC201"]  # 109
"bluemira/fuel_cycle/*" = ["DOC201", "TD"]  # 19
"bluemira/equilibria/*" = ["DOC201"]  # 217
"bluemira/display/*" = ["DOC201"]  # 25
"bluemira/codes/*" = ["DOC201"]  # 242
"bluemira/builders/*" = ["DOC201"]  # 69
"bluemira/base/*" = ["DOC201"]  # 56
"bluemira/balance_of_plant/*" = ["DOC201"]  # 56