pyproject.toml

[build-system]
requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi"

[project]
# Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
name = "ansys-mapdl-core"
version = "0.69.dev0"
description = "A Python wrapper for Ansys MAPDL."
readme = "README.md"
requires-python = ">=3.9,<3.13"  # Update also 'MINIMUM_PYTHON_VERSION' in src/ansys/mapdl/core/__init__.py
license = {file = "LICENSE"}
authors = [
    {name = "Ansys, Inc.", email = "pyansys.maintainers@ansys.com"},
]
maintainers = [
    {name = "PyAnsys developers", email = "pyansys.maintainers@ansys.com"},
]
dependencies = [
    "ansys-api-mapdl==0.5.1",  # supports at least 2020R2 - 2022R1
    "ansys-mapdl-reader>=0.51.7",
    "ansys-math-core>=0.1.2",
    "ansys-platform-instancemanagement~=1.0",
    "platformdirs>=3.6.0",
    "click>=8.1.3", # for CLI interface
    "tabulate>=0.8.0", # for cli plotting
    "grpcio>=1.30.0",  # tested up to grpcio==1.35
    "importlib-metadata>=4.0",
    "matplotlib>=3.0.0",  # for colormaps for pyvista
    "numpy>=1.14.0,<1.25.0; python_version < '3.9'",
    "numpy>=1.14.0,<2.0.0; python_version >= '3.9'",
    "pexpect>=4.8.0 ; platform_system=='Linux'",
    "protobuf>=3.12.2",  # minimum required based on latest ansys-grpc-mapdl
    "psutil>=5.9.4",
    "pyansys-tools-versioning>=0.3.3",
    "ansys-tools-path>=0.3.1",
    "pyiges[full]>=0.3.1", # Since v0.3.0, the 'full' flag is needed in order to install 'geomdl'
    "pyvista>=0.38.1",
    "scipy>=1.3.0",  # for sparse (consider optional?)
    "tqdm>=4.45.0",
    "vtk>=9.0.0",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering :: Information Analysis",
    "License :: OSI Approved :: MIT License",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: POSIX",
    "Operating System :: MacOS",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
]

[project.optional-dependencies]
jupyter = [
    "jupyterlab>=3",
    "ipywidgets",
    "pyvista[jupyter]",
]

tests = [
    "ansys-dpf-core==0.10.1",
    "autopep8==2.2.0",
    "matplotlib==3.9.0",
    "scipy==1.13.1",
    "pandas==2.2.2",
    "pyiges[full]==0.3.1",
    "pytest==8.2.1",
    "pytest-cov==5.0.0",
    "pyvista==0.43.8",
    "pyansys-tools-report==0.7.3",
    "vtk==9.3.0",
    "pytest-rerunfailures==14.0",
    "pytest-pyvista==0.1.9",
    "pytest-memprof<0.3.0",
]
doc = [
    "sphinx==7.3.7",
    "ansys-dpf-core==0.10.1",
    "ansys-mapdl-reader==0.53.0",
    "ansys-sphinx-theme==0.16.4",
    "grpcio==1.64.0",
    "imageio-ffmpeg==0.4.9",
    "imageio==2.34.1",
    "jupyter_sphinx==0.5.3",
    "jupyterlab>=3.2.8",
    "matplotlib==3.9.0",
    "numpydoc==1.7.0",
    "pandas==2.2.2",
    "plotly==5.22.0",
    "pyiges[full]==0.3.1",
    "pypandoc==1.13",
    "pytest-sphinx==0.6.3",
    "pythreejs==2.4.2",
    "pyvista[trame]==0.43.8",
    "sphinx-autobuild==2024.4.16",
    "sphinx-autodoc-typehints==1.25.2",
    "sphinx-copybutton==0.5.2",
    "sphinx-design==0.6.0",
    "sphinx-gallery==0.16.0",
    "sphinx-notfound-page==1.0.2",
    "sphinxcontrib-websupport==1.2.7",
    "sphinxemoji==0.3.1",
    "sphinx-reredirects==0.1.3",
    "vtk==9.3.0",
]

[tool.flit.module]
name = "ansys.mapdl.core"

[project.urls]
Source = "https://github.com/ansys/pymapdl"

[project.scripts]
pymapdl_convert_script = "ansys.mapdl.core.cli:old_pymapdl_convert_script_entry_point"
pymapdl = "ansys.mapdl.core.cli:main"

[tool.pytest.ini_options]
junit_family = "legacy"
filterwarnings = [
    "ignore::FutureWarning",
    "ignore::PendingDeprecationWarning",
    "ignore::DeprecationWarning",
    # bogus numpy ABI warning (see numpy/#432)
    "ignore:.*numpy.dtype size changed.*:RuntimeWarning",
    "ignore:.*numpy.ufunc size changed.*:RuntimeWarning",
    "ignore::UserWarning",
]
markers = [
    "skip_grpc: skip tests using grpc",
    "gui: skip tests that launch the GUI interface",
]
testpaths = "tests"
image_cache_dir = "tests/.image_cache"

[tool.isort]
profile = "black"
force_sort_within_sections = true
default_section = "THIRDPARTY"
skip_glob = ["__init__.py"]
src_paths = ["doc", "src", "tests"]


[tool.coverage.run]
source = ["ansys/pymapdl"]
omit = [
    # omit commands
    "ansys/mapdl/core/_commands/*",
    # ignore legacy interfaces
    "ansys/mapdl/core/mapdl_console.py",
    "ansys/mapdl/core/jupyter.py",
]

[tool.coverage.report]
show_missing = true

[tool.codespell]
skip = '*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,*.cdb,*.CDB,build,./docker/mapdl/v*,./factory/*,./ansys/mapdl/core/mapdl_functions.py,PKG-INFO,*.mypy_cache/*,./docker/mapdl/*,./_unused/*'
ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt"
quiet-level = 3
ignore-regex=".*codespell-ignore$|NORML|POIN"

[tool.numpydoc_validation]
checks = [
    #"all",   # report on all checks, except the below
  # "GL01", # "Docstring text (summary) should start in the line immediately "
    # "after the opening quotes (not in the same line, or leaving a "
    # "blank line in between)",
  # "GL02", # "Closing quotes should be placed in the line after the last text "
    # "in the docstring (do not close the quotes in the same line as "
    # "the text, or leave a blank line between the last text and the "
    # "quotes)",
  # "GL03", # "Double line break found; please use only one blank line to "
    # "separate sections or paragraphs, and do not leave blank lines "
    # "at the end of docstrings",
    "GL05", # 'Tabs found at the start of line "{line_with_tabs}", please use '
    # "whitespace only",
  # "GL06", # 'Found unknown section "{section}". Allowed sections are: '
    # "{allowed_sections}",
  #  "GL07", # "Sections are in the wrong order. Correct order is: {correct_sections}",
  # "GL08", # "The object does not have a docstring",
  # "GL09", # "Deprecation warning should precede extended summary",
    "GL10", # "reST directives {directives} must be followed by two colons",
  # "SS01", # "No summary found (a short summary in a single line should be "
    # "present at the beginning of the docstring)",
    "SS02", # "Summary does not start with a capital letter",
  # "SS03", # "Summary does not end with a period",
    "SS04", # "Summary contains heading whitespaces",
  #  "SS05", # "Summary must start with infinitive verb, not third person "
    # '(e.g. use "Generate" instead of "Generates")',
  # "SS06", # "Summary should fit in a single line",
  # "ES01", # "No extended summary found",
  # "PR01", # "Parameters {missing_params} not documented",
  # "PR02", # "Unknown parameters {unknown_params}",
    "PR03", # "Wrong parameters order. Actual: {actual_params}. "
    # "Documented: {documented_params}",
  # "PR04", # 'Parameter "{param_name}" has no type',
    "PR05", # 'Parameter "{param_name}" type should not finish with "."',
    "PR06", # 'Parameter "{param_name}" type should use "{right_type}" instead '
    # 'of "{wrong_type}"',
    "PR07", # 'Parameter "{param_name}" has no description',
  # "PR08", # 'Parameter "{param_name}" description should start with a '
    # "capital letter",
  # "PR09", # 'Parameter "{param_name}" description should finish with "."',
  # "PR10", # 'Parameter "{param_name}" requires a space before the colon '
    # "separating the parameter name and type",
  # "RT01", # "No Returns section found",
  # "RT02", # "The first line of the Returns section should contain only the "
    # "type, unless multiple values are being returned",
  # "RT03", # "Return value has no description",
  # "RT04", # "Return value description should start with a capital letter",
  # "RT05", # 'Return value description should finish with "."',
    "YD01", # "No Yields section found",
  # "SA01", # "See Also section not found",
    "SA02", # "Missing period at end of description for See Also "
    # '"{reference_name}" reference',
    "SA03", # "Description should be capitalized for See Also "
    # '"{reference_name}" reference',
    "SA04", # 'Missing description for See Also "{reference_name}" reference',
  # "EX01", # "No examples section found",
]


override_SS05 = [  # override SS05 to allow docstrings starting with these words
    # '^Process ',
    # '^Assess ',
    # '^Access ',
]