From aee2f55b7097c4f577650e1be2b8a4c91c277729 Mon Sep 17 00:00:00 2001 From: moe-ad Date: Tue, 1 Apr 2025 10:50:38 +0200 Subject: [PATCH 1/5] chore: graphics target --- .github/workflows/ci.yml | 4 ++-- .github/workflows/ci_release.yml | 4 ++-- .github/workflows/docs.yml | 2 +- .github/workflows/examples.yml | 2 +- doc/source/getting_started/install.rst | 2 +- pyproject.toml | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f63e3b4e1..9c36066ad 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -101,7 +101,7 @@ jobs: PACKAGE_NAME: ${{env.PACKAGE_NAME}} MODULE: ${{env.MODULE}} dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}} - install_extras: plotting + install_extras: graphics # Upload the wheel artifact for only one of the OS as it is OS-agnostic wheel: ${{ (matrix.python-version == env.MAIN_PYTHON_VERSION) && (matrix.os == 'windows-latest') }} wheelhouse: true @@ -172,7 +172,7 @@ jobs: PACKAGE_NAME: ${{env.PACKAGE_NAME}} MODULE: ${{env.MODULE}} dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}} - install_extras: plotting + install_extras: graphics wheel: false standalone_suffix: ${{ matrix.ANSYS_VERSION == '241' && '.sp01' || '' }} diff --git a/.github/workflows/ci_release.yml b/.github/workflows/ci_release.yml index 176eb8487..d39296c8c 100644 --- a/.github/workflows/ci_release.yml +++ b/.github/workflows/ci_release.yml @@ -84,7 +84,7 @@ jobs: PACKAGE_NAME: ${{env.PACKAGE_NAME}} MODULE: ${{env.MODULE}} dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}} - install_extras: plotting + install_extras: graphics # Upload the wheel artifact for only one of the OS as it is OS-agnostic wheel: ${{ (matrix.python-version == env.MAIN_PYTHON_VERSION) && (matrix.os == 'windows-latest') }} wheelhouse: true @@ -153,7 +153,7 @@ jobs: PACKAGE_NAME: ${{env.PACKAGE_NAME}} MODULE: ${{env.MODULE}} dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}} - install_extras: plotting + install_extras: graphics wheel: false extra-pip-args: ${{ env.extra }} diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2c6c288a2..0aaa67f23 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -100,7 +100,7 @@ jobs: PACKAGE_NAME: ${{env.PACKAGE_NAME}} MODULE: ${{env.MODULE}} dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}} - install_extras: plotting + install_extras: graphics wheel: false wheelhouse: false standalone_suffix: ${{ inputs.standalone_suffix }} diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index db644d260..8d6cc2d18 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -84,7 +84,7 @@ jobs: PACKAGE_NAME: ${{ env.PACKAGE_NAME }} MODULE: ${{ env.MODULE }} dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}} - install_extras: plotting + install_extras: graphics wheelhouse: false wheel: false standalone_suffix: ${{ inputs.standalone_suffix }} diff --git a/doc/source/getting_started/install.rst b/doc/source/getting_started/install.rst index f1c7005c7..c0c26b865 100644 --- a/doc/source/getting_started/install.rst +++ b/doc/source/getting_started/install.rst @@ -31,7 +31,7 @@ To install PyDPF-Post with its optional plotting functionalities, use this comma .. code:: bash - pip install ansys-dpf-post[plotting] + pip install ansys-dpf-post[graphics] For more information about PyDPF-Post plotting capabilities, see :ref:`user_guide_plotting`. diff --git a/pyproject.toml b/pyproject.toml index 47fec8538..73e83a055 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,7 +41,7 @@ name = "ansys.dpf.post" Source = "https://github.com/ansys/pydpf-post" [project.optional-dependencies] -plotting = [ +graphics = [ "pyvista>=0.24.0", ] From 7ceb217d8637978f2496c2fd7299efa395d179c9 Mon Sep 17 00:00:00 2001 From: moe-ad Date: Thu, 3 Apr 2025 14:24:00 +0200 Subject: [PATCH 2/5] fix: try fixing doc gen error --- requirements/requirements_docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt index b9d7a0b93..bb38799ac 100644 --- a/requirements/requirements_docs.txt +++ b/requirements/requirements_docs.txt @@ -9,7 +9,7 @@ pytest-sphinx==0.6.3 sphinx-notfound-page==1.1.0 sphinx-copybutton==0.5.0 sphinx-gallery==0.19.0 -ansys_sphinx_theme==1.3.1 +ansys_sphinx_theme==1.4.1 sphinx-autodoc-typehints==3.0.1 pyvista==0.44.2 vtk==9.3.1 From 0531e7ac56116b1111201ba05075d89396a865f2 Mon Sep 17 00:00:00 2001 From: moe-ad Date: Thu, 3 Apr 2025 14:46:48 +0200 Subject: [PATCH 3/5] fix: send error to stdout --- .github/workflows/docs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0aaa67f23..c00525b0b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -130,7 +130,8 @@ jobs: export TEMP=${{ runner.temp }} make clean echo "Making html doc..." - make html $DEBUG_HTML >> log.txt 2>&1 + make html +# make html $DEBUG_HTML >> log.txt 2>&1 - name: "Check for success" shell: bash From 55d286bf30ef1d9f7c42e5410a1e43c45e947141 Mon Sep 17 00:00:00 2001 From: moe-ad Date: Tue, 29 Apr 2025 10:48:58 +0200 Subject: [PATCH 4/5] retro: compatibility --- doc/source/getting_started/install.rst | 6 ++++++ pyproject.toml | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/doc/source/getting_started/install.rst b/doc/source/getting_started/install.rst index c0c26b865..a7874c0f9 100644 --- a/doc/source/getting_started/install.rst +++ b/doc/source/getting_started/install.rst @@ -33,6 +33,12 @@ To install PyDPF-Post with its optional plotting functionalities, use this comma pip install ansys-dpf-post[graphics] +.. warning:: + + ``pip install ansys-dpf-post[plotting]`` is equivalent to the previous command, however, the "plotting" target + only remains valid for legacy reasons and will soon be deprecated. Users are encouraged to use the "graphics" + target instead. + For more information about PyDPF-Post plotting capabilities, see :ref:`user_guide_plotting`. diff --git a/pyproject.toml b/pyproject.toml index 73e83a055..b96ae8547 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,6 +45,10 @@ graphics = [ "pyvista>=0.24.0", ] +plotting = [ + "pyvista>=0.24.0", +] + [tool.pytest.ini_options] minversion = "7.1" addopts = "-ra --cov=ansys.dpf.post --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv" From b18f9e0e8e2a17a5d6f3947fae0b4ac4b0821f61 Mon Sep 17 00:00:00 2001 From: moe-ad Date: Mon, 19 May 2025 11:44:39 +0200 Subject: [PATCH 5/5] fix: revert --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a5951cf63..7d5a09732 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -131,7 +131,7 @@ jobs: make clean echo "Making html doc..." make html -# make html $DEBUG_HTML >> log.txt 2>&1 + make html $DEBUG_HTML >> log.txt 2>&1 - name: "Check for success" shell: bash