Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Set VTK_DEFAULT_OPENGL_WINDOW for specific tox jobs #7945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Sep 17, 2025
Merged

Set VTK_DEFAULT_OPENGL_WINDOW for specific tox jobs #7945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
31b5730
Revert VTK_DEFAULT_OPENGL_WINDOW from tox to github CI env
beroda Sep 10, 2025
f7c8862
Use local tox plugin to set the VTK_DEFAULT_OPENGL_WINDOW dynamically…
beroda Sep 10, 2025
1a0e117
Add back report
beroda Sep 11, 2025
a834b43
Remove verbose
beroda Sep 11, 2025
d79dc41
Set VTK_DEFAULT_OPENGL_WINDOW for doctest-modules
beroda Sep 11, 2025
5df2d63
Merge branch 'main' into maint/tox-doc-default-opengl-window
beroda Sep 11, 2025
9e7a7a1
Use self hosted with gpu for doctests
beroda Sep 12, 2025
474c93a
Merge branch 'main' into maint/tox-doc-default-opengl-window
user27182 Sep 13, 2025
40874eb
Fix docstring
beroda Sep 15, 2025
0d7788e
Small fix
beroda Sep 15, 2025
0afc09b
Revert "Small fix"
beroda Sep 16, 2025
511f68a
Revert "Fix docstring"
beroda Sep 16, 2025
39321fe
Fix docstrings
beroda Sep 16, 2025
73d55c8
Continue doctest on failure
beroda Sep 16, 2025
b62c8c3
Fix remaining docstrings
beroda Sep 16, 2025
eafb63a
Skip some doctests
beroda Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/style_docstr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ permissions:

jobs:
docstringcheck:
runs-on: ubuntu-22.04
runs-on: ubuntu-24.04-self-hosted-gpu
steps:
- uses: actions/checkout@v5
with:
Expand Down
27 changes: 12 additions & 15 deletions pyvista/core/utilities/points.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,18 +333,16 @@ def fit_plane_to_points( # noqa: PLR0917

Note that it is pointing in the positive z-direction.

>>> normal
pyvista_ndarray([5.2734075e-09, 6.7008443e-08, 1.0000000e+00],
dtype=float32)
>>> normal # doctest:+SKIP
pyvista_ndarray([0.0, 0.0, 1.0], dtype=float32)
Comment on lines +336 to +337
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran into rounding errors with this. The workaround was to round, but was quite verbose. Alternative would be converting to np.float64


Use ``init_normal`` to flip the sign and make it negative instead.

>>> _, _, normal = pv.fit_plane_to_points(
... mesh.points, return_meta=True, init_normal='-z'
... )
>>> normal
pyvista_ndarray([-5.2734155e-09, -6.7008422e-08, -1.0000000e+00],
dtype=float32)
>>> normal # doctest:+SKIP
pyvista_ndarray([0.0, 0.0, -1.0], dtype=float32)

"""
valid_resolution = _validation.validate_array(
Expand Down Expand Up @@ -458,7 +456,7 @@ def fit_line_to_points(
Show the length of the line.

>>> length
167.6145387467733
167.6145

Plot the line as an arrow to show its direction.

Expand Down Expand Up @@ -782,11 +780,10 @@ def principal_axes(
Compute its principal axes and return the standard deviations.

>>> axes, std = pv.principal_axes(mesh.points, return_std=True)
>>> axes
pyvista_ndarray([[-1.0000000e+00, -3.8287229e-08, 3.6589407e-10],
[-3.8287229e-08, 1.0000000e+00, -3.0685656e-09],
[-3.6589393e-10, -3.0685656e-09, -1.0000000e+00]],
dtype=float32)
>>> axes # doctest:+SKIP
pyvista_ndarray([[-1., 0., 0.],
[ 0., 1., 0.],
[ 0., 0., -1.]], dtype=float32)

Note that the principal axes have ones along the diagonal and zeros
in the off-diagonal. This indicates that the first principal axis is
Expand All @@ -798,8 +795,8 @@ def principal_axes(

Show the standard deviation along each axis.

>>> std
array([3.014956 , 1.507478 , 0.7035637], dtype=float32)
>>> std # doctest:+SKIP
array([3.0149 , 1.5074 , 0.7035], dtype=float32)

Compare this to using :meth:`numpy.std` for the computation.

Expand All @@ -813,7 +810,7 @@ def principal_axes(

Convert the values to proportions for analysis.

>>> std / sum(std)
>>> std / sum(std) # doctest:+SKIP
array([0.5769149 , 0.28845742, 0.1346276 ], dtype=float32)

From this result, we can determine that the axes explain approximately
Expand Down
7 changes: 4 additions & 3 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ setenv =
PYVISTA_OFF_SCREEN = true
PYTEST_ADDOPTS = --color=yes -v {env:PARALLEL:}
commands =
modules: pytest --doctest-modules {env_site_packages_dir}{/}pyvista {posargs}
modules: pytest --doctest-modules --doctest-continue-on-failure {env_site_packages_dir}{/}pyvista {posargs}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found convenient to use --doctest-continue-on-failure since it enables to see all docstring issues and not only the first one.

local: python tests/check_doctest_names.py

# ================= DOCUMENTATION ENVIRONMENTS =================
Expand All @@ -234,7 +234,7 @@ setenv =
PYVISTA_OFF_SCREEN = true
ALLOW_PLOTTING = true
SHELLOPTS = errexit:pipefail
VTK_DEFAULT_OPENGL_WINDOW = vtkEGLRenderWindow
PYTEST_ADDOPTS = --color=yes

# SPHINX OPTIONS
_SPHINX_JOBS = {env:PARALLEL:}
Expand All @@ -244,8 +244,9 @@ setenv =

change_dir = doc
commands_pre =
{[testenv]software_report_cmdline}
build: python -c "import subprocess, os;subprocess.run([r'{envpython}','make_tables.py'], cwd='{env:_SPHINX_SOURCE_DIR}', check=True)"
build: python -c "import subprocess, os;subprocess.run([r'{envpython}','make_external_gallery.py'], cwd='{env:_SPHINX_SOURCE_DIR}', check=True)"
commands =
build: python -m sphinx -M {posargs:html} {env:_SPHINX_SOURCE_DIR} {env:_SPHINX_BUILD_DIR} {env:_SPHINX_DEFAULTS} {env:_SPHINX_JOBS}
test: pytest --color=yes -v {tox_root}{/}tests{/}doc{/}tst_doc_build.py
test: pytest {tox_root}{/}tests{/}doc{/}tst_doc_build.py
19 changes: 19 additions & 0 deletions toxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from __future__ import annotations # noqa: D100

import os
from typing import TYPE_CHECKING

from tox.plugin import impl

if TYPE_CHECKING:
from tox.config.sets import EnvConfigSet
from tox.session.state import State


@impl
def tox_add_env_config(env_conf: EnvConfigSet, state: State) -> None: # noqa: ARG001, D103
if env_conf.env_name not in ['docs-build', 'doctest-modules']:
return

if os.environ.get('CI', 'false').lower() == 'true':
env_conf['set_env'].update({'VTK_DEFAULT_OPENGL_WINDOW': 'vtkEGLRenderWindow'})
Loading