Merge branch 'main' into maint/intersphix

ansys · Jul 29, 2024 · 6356f9d · 6356f9d
2 parents c8adad8 + 681adab
commit 6356f9d
Show file tree

Hide file tree

Showing 54 changed files with 196 additions and 145 deletions.
diff --git a/.github/workflows/package_cleanup.yml b/.github/workflows/package_cleanup.yml
@@ -0,0 +1,22 @@
+name: Package cleanup
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '00 22 * * *'
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  cleanup:
+    name: "Delete untagged package versions"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Delete untagged package versions"
+        uses: ansys/actions/hk-package-clean-untagged@v6
+        with:
+          package-org: 'ansys'
+          package-name: 'mechanical'
+          allow-last-days: '7'
+          token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -189,13 +189,8 @@ cython_debug/
 
 # End of https://www.toptal.com/developers/gitignore/api/python
 
-doc/source/examples/gallery_examples/*.rst
-doc/source/examples/gallery_examples/*/*.ipynb
-doc/source/examples/gallery_examples/*/*.py
-doc/source/examples/gallery_examples/*/*.md5
-doc/source/examples/gallery_examples/*/*.rst
-doc/source/examples/gallery_examples/*/*.pickle
-doc/source/examples/gallery_examples/**/*.png
+doc/source/examples/gallery_examples/**
+
 doc/source/sg_execution_times.rst
 
 # Ignore everything in the doc/source/api/ directory

diff --git a/README.rst b/README.rst
@@ -119,7 +119,8 @@ on Windows and Linux for version 2023 R2 and later. Here is an example:
    import ansys.mechanical.core as pymechanical
 
    app = pymechanical.App()
-   project_dir = app.ExtAPI.DataModel.Project.ProjectDirectory
+   app.update_globals(globals())
+   project_dir = DataModel.Project.ProjectDirectory
 
 Documentation and issues
 ------------------------

diff --git a/doc/Makefile b/doc/Makefile
@@ -35,4 +35,10 @@ clean-except-examples:
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
-	(test -f $(BUILDDIR)/latex/*.pdf && echo pdf exists) || exit 1
+	(test -f $(BUILDDIR)/latex/*.pdf && echo pdf exists) || exit 1
+
+# generate docs without examples
+html-noplot:
+	@$(SPHINXBUILD) -D plot_gallery=0 -b html $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(O)
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
diff --git a/doc/changelog.d/760.added.md b/doc/changelog.d/760.added.md
diff --git a/doc/changelog.d/773.dependencies.md b/doc/changelog.d/773.dependencies.md
diff --git a/doc/changelog.d/786.changed.md b/doc/changelog.d/786.changed.md
diff --git a/doc/changelog.d/787.added.md b/doc/changelog.d/787.added.md
diff --git a/doc/changelog.d/789.changed.md b/doc/changelog.d/789.changed.md
diff --git a/doc/changelog.d/790.added.md b/doc/changelog.d/790.added.md
diff --git a/doc/changelog.d/796.miscellaneous.md b/doc/changelog.d/796.miscellaneous.md
diff --git a/doc/changelog.d/800.fixed.md b/doc/changelog.d/800.fixed.md
diff --git a/doc/changelog.d/801.changed.md b/doc/changelog.d/801.changed.md
diff --git a/doc/changelog.d/802.added.md b/doc/changelog.d/802.added.md
diff --git a/doc/changelog.d/803.changed.md b/doc/changelog.d/803.changed.md
diff --git a/doc/changelog.d/804.added.md b/doc/changelog.d/804.added.md
diff --git a/doc/changelog.d/805.dependencies.md b/doc/changelog.d/805.dependencies.md
diff --git a/doc/changelog.d/806.changed.md b/doc/changelog.d/806.changed.md
diff --git a/doc/changelog.d/810.changed.md b/doc/changelog.d/810.changed.md
diff --git a/doc/changelog.d/811.changed.md b/doc/changelog.d/811.changed.md
diff --git a/doc/changelog.d/812.miscellaneous.md b/doc/changelog.d/812.miscellaneous.md
diff --git a/doc/changelog.d/814.dependencies.md b/doc/changelog.d/814.dependencies.md
diff --git a/doc/changelog.d/815.changed.md b/doc/changelog.d/815.changed.md
diff --git a/doc/changelog.d/818.dependencies.md b/doc/changelog.d/818.dependencies.md
diff --git a/doc/changelog.d/819.changed.md b/doc/changelog.d/819.changed.md
diff --git a/doc/changelog.d/821.dependencies.md b/doc/changelog.d/821.dependencies.md
diff --git a/doc/changelog.d/824.changed.md b/doc/changelog.d/824.changed.md
@@ -0,0 +1 @@
+chore: update CHANGELOG for v0.11.3
diff --git a/doc/changelog.d/826.dependencies.md b/doc/changelog.d/826.dependencies.md
@@ -0,0 +1 @@
+MAINT: Bump grpcio from 1.64.1 to 1.65.1 in the core group
diff --git a/doc/changelog.d/827.dependencies.md b/doc/changelog.d/827.dependencies.md
@@ -0,0 +1 @@
+MAINT: Bump pytest from 8.2.2 to 8.3.1 in the tests group
diff --git a/doc/changelog.d/788.dependencies.md → doc/changelog.d/828.dependencies.md b/doc/changelog.d/788.dependencies.md → doc/changelog.d/828.dependencies.md
diff --git a/doc/changelog.d/829.added.md b/doc/changelog.d/829.added.md
@@ -0,0 +1 @@
+DOC: Update known issues and limitations
diff --git a/doc/changelog.d/830.added.md b/doc/changelog.d/830.added.md
@@ -0,0 +1 @@
+Feat: Add option for generating docs without examples
diff --git a/doc/changelog.d/831.miscellaneous.md b/doc/changelog.d/831.miscellaneous.md
@@ -0,0 +1 @@
+DOC: Add documentation for ``launch_mechanical``
diff --git a/doc/changelog.d/833.fixed.md b/doc/changelog.d/833.fixed.md
@@ -0,0 +1 @@
+Maint: Update qk_07 test
diff --git a/doc/make.bat b/doc/make.bat
@@ -12,6 +12,7 @@ set BUILDDIR=_build
 set LINKCHECKDIR=\%BUILDDIR%\linkcheck
 
 if "%1" == "" goto help
+if "%1" == "html-noplot" goto html-noplot
 if "%1" == "clean" goto clean
 if "%1" == "pdf" goto pdf
 if "%1" == "linkcheck" goto linkcheck
@@ -32,6 +33,10 @@ if errorlevel 9009 (
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
+:html-noplot
+%SPHINXBUILD% -D plot_gallery=0 -b html %SOURCEDIR% %BUILDDIR%/html %SPHINXOPTS% %O%
+goto end
+
 :clean
 rmdir /s /q %BUILDDIR% > /NUL 2>&1
 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
@@ -57,4 +62,3 @@ goto end
 
 :end
 popd
-
diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst
@@ -9,6 +9,63 @@ This document contains the release notes for the project.
 
 .. towncrier release notes start
 
+`0.11.3 <https://github.com/ansys/pymechanical/releases/tag/v0.11.3>`_ - 2024-07-19
+===================================================================================
+
+Changed
+^^^^^^^
+
+- MAINT: Updates for 242 `#822 <https://github.com/ansys/pymechanical/pull/822>`_
+- chore: update CHANGELOG for v0.11.2 `#823 <https://github.com/ansys/pymechanical/pull/823>`_
+
+`0.11.2 <https://github.com/ansys/pymechanical/releases/tag/v0.11.2>`_ - 2024-07-19
+===================================================================================
+
+Added
+^^^^^
+
+- FEAT: Add known issues and limitation section `#760 <https://github.com/ansys/pymechanical/pull/760>`_
+- FEAT: Add test for building gallery `#787 <https://github.com/ansys/pymechanical/pull/787>`_
+- FEAT: Add graphics and globals `#790 <https://github.com/ansys/pymechanical/pull/790>`_
+- feat: add --script-args argument to ansys-mechanical `#802 <https://github.com/ansys/pymechanical/pull/802>`_
+- FEAT: Update print_tree method `#804 <https://github.com/ansys/pymechanical/pull/804>`_
+
+
+Changed
+^^^^^^^
+
+- chore: update CHANGELOG for v0.11.1 `#786 <https://github.com/ansys/pymechanical/pull/786>`_
+- [pre-commit.ci] pre-commit autoupdate `#789 <https://github.com/ansys/pymechanical/pull/789>`_, `#801 <https://github.com/ansys/pymechanical/pull/801>`_, `#819 <https://github.com/ansys/pymechanical/pull/819>`_
+- MAINT: Update nightly runs for 251 `#803 <https://github.com/ansys/pymechanical/pull/803>`_
+- MAINT: Refactor CICD `#806 <https://github.com/ansys/pymechanical/pull/806>`_
+- MAINT: Update for 24R2 `#810 <https://github.com/ansys/pymechanical/pull/810>`_
+- MAINT: update for docker files 24R2 `#811 <https://github.com/ansys/pymechanical/pull/811>`_
+- Update ACT API Reference Guide link `#815 <https://github.com/ansys/pymechanical/pull/815>`_
+
+
+Fixed
+^^^^^
+
+- Fix sentence in architecture file `#800 <https://github.com/ansys/pymechanical/pull/800>`_
+
+
+Dependencies
+^^^^^^^^^^^^
+
+- MAINT: Bump numpy from 1.26.4 to 2.0.0 `#773 <https://github.com/ansys/pymechanical/pull/773>`_
+- MAINT: Bump the doc group with 4 updates `#788 <https://github.com/ansys/pymechanical/pull/788>`_
+- MAINT: Bump the doc group with 2 updates `#805 <https://github.com/ansys/pymechanical/pull/805>`_
+- MAINT: Update dev version of pymechanical `#814 <https://github.com/ansys/pymechanical/pull/814>`_
+- MAINT: Bump sphinx from 7.3.7 to 7.4.4 in the doc group `#818 <https://github.com/ansys/pymechanical/pull/818>`_
+- MAINT: Update pymech-env `#821 <https://github.com/ansys/pymechanical/pull/821>`_
+
+
+Miscellaneous
+^^^^^^^^^^^^^
+
+- docs: update architecture.rst `#796 <https://github.com/ansys/pymechanical/pull/796>`_
+- fix exception when plotting a model with any line bodies `#812 <https://github.com/ansys/pymechanical/pull/812>`_
+
 `0.11.1 <https://github.com/ansys/pymechanical/releases/tag/v0.11.1>`_ - 2024-06-21
 ===================================================================================
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -345,6 +345,7 @@ def intersphinx_pymechanical(switcher_version: str):
     "https://answers.microsoft.com/en-us/windows/forum/all/*",
     "https://download.ansys.com/*",
     "https://support.ansys.com/*",
+    "https://discuss.ansys.com/*",
     "../api/*",  # Remove this after release 0.10.12
     "path.html",
 ]

diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
@@ -13,39 +13,32 @@ Getting started
 
         How to install and verify PyMechanical.
 
-    .. grid-item-card:: :fas:`fa-solid fa-code-compare` Versioning
-        :link: versioning
-        :link-type: doc
-        :text-align: center
-
-        Versioning requirements and support for Ansys Mechanical.
-
-.. grid:: 2
-    :gutter: 2 2 3 4
-
     .. grid-item-card:: :fas:`fa-solid fa-gears` Launching PyMechanical
         :link: running_mechanical
         :link-type: doc
         :text-align: center
 
         Steps to run PyMechanical.
 
+.. grid:: 2
+    :gutter: 2 2 3 4
+
     .. grid-item-card:: :fab:`fa-brands fa-docker` Docker setup
         :link: docker
         :link-type: doc
         :text-align: center
 
-        Steps for creating mechanical docker images.
-
-.. grid:: 2
-    :gutter: 2 2 3 4
+        How to create mechanical docker images.
 
     .. grid-item-card:: :fab:`fa-brands fa-ubuntu` WSL
         :link: wsl
         :link-type: doc
         :text-align: center
 
-        How to install PyMechanical on the Linux platform using a Windows Subsystem.
+        Installing PyMechanical on Linux via WSL.
+
+.. grid:: 2
+    :gutter: 2 2 3 4
 
     .. grid-item-card:: :fas:`fa-solid fa-clipboard-question` FAQs
         :link: faq
@@ -54,13 +47,20 @@ Getting started
 
         Frequently asked questions and answers.
 
+    .. grid-item-card:: :fas:`fa-solid fa-bug` Known issues and limitations
+        :link: ../kil/index
+        :link-type: doc
+        :text-align: center
+
+        Known issues and limitations of Mechanical and PyMechanical.
+
 .. toctree::
    :hidden:
    :maxdepth: 2
 
    installation
-   versioning
    running_mechanical
    docker
    wsl
+   ../kil/index
    faq
diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst
@@ -3,13 +3,11 @@
 Installation guide
 ==================
 
-To run PyMechanical, you must have a licensed copy of Ansys Mechanical
-installed locally. The version installed dictates the interface and
-features that are available to you.
-
-PyMechanical is compatible with Mechanical 2023 R1 and later on Windows
-and Linux. For more information please refer to  :ref:`ref_versioning` documentation.
-Later releases provide significantly better support and features.
+To use PyMechanical, a licensed copy of Ansys Mechanical must be installed locally.
+The installed version determines the available interface and features.
+PyMechanical is compatible with Mechanical **2023 R2** and later on Windows
+and Linux. If you face any issues while setting up or using PyMechanical,
+please go though :ref:`FAQs <faq>` and :ref:`known issues and limitations <ref_known_issues_and_limitation>` sections.
 
 Install the package
 -------------------
@@ -120,8 +118,7 @@ Verify your installation by loading an embedded instance of Mechanical in Python
 .. note::
    If you are running on Linux, you must set some environment variables for
    embedding of Mechanical in Python to work. A script that sets these variables is
-   available to install using pip:
-   ``pip install ansys-mechanical-env``
+   shipped with ``ansys-mechanical-env`` which is part of PyMechanical
 
 To use the script, prepend it to any invocation of Python:
 

diff --git a/doc/source/getting_started/running_mechanical.rst b/doc/source/getting_started/running_mechanical.rst
@@ -106,7 +106,7 @@ usage, type the following command:
 You can launch Mechanical in server mode from the command line and then
 manually connect to the server. Use the `port` argument to select the port.
 
-..code::
+.. code::
 
     ansys-mechanical --port 10000
 

diff --git a/doc/source/getting_started/versioning.rst b/doc/source/getting_started/versioning.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		MAINT: Bump grpcio from 1.64.1 to 1.65.1 in the core group
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		MAINT: Bump pytest from 8.2.2 to 8.3.1 in the tests group
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Feat: Add option for generating docs without examples
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		DOC: Add documentation for ``launch_mechanical``