Merge branch 'main' into release/0.6

RobPasMue · RobPasMue · commit e61bdc58640e · 2024-06-12T09:33:28.000+02:00
diff --git a/.github/workflows/nightly_docker_test.yml b/.github/workflows/nightly_docker_test.yml
@@ -7,9 +7,15 @@ on:
   push:
     paths:
       - '.github/workflows/nightly_docker_test.yml'
+    # Sequence of patterns matched against refs/heads
+    branches-ignore:
+      - 'release/**'
+    # Sequence of patterns matched against refs/tags
+    tags-ignore:
+      - v*
 
 env:
-  MAIN_PYTHON_VERSION: '3.12'
+  MAIN_PYTHON_VERSION: '3.11'
   ANSRV_GEO_IMAGE_WINDOWS_TAG: ghcr.io/ansys/geometry:windows-latest-unstable
   ANSRV_GEO_IMAGE_LINUX_TAG: ghcr.io/ansys/geometry:linux-latest-unstable
   ANSRV_GEO_PORT: 710
@@ -38,8 +44,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
-          cache: 'pip'
-          cache-dependency-path: 'pyproject.toml'
 
       - name: Set up headless display
         uses: pyvista/setup-headless-display-action@v2
diff --git a/README.rst b/README.rst
@@ -1,6 +1,8 @@
 PyAnsys Geometry
 ================
-|pyansys| |python| |pypi| |downloads| |GH-CI| |codecov| |MIT| |black| |pre-commit|
+|pyansys| |python| |MIT| |black|
+|codecov| |GH-CI| |pre-commit|
+|pypi| |pypi-downloads| |conda| |conda-downloads|
 
 .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
    :target: https://docs.pyansys.com/
@@ -10,14 +12,22 @@ PyAnsys Geometry
    :target: https://pypi.org/project/ansys-geometry-core/
    :alt: Python
 
-.. |pypi| image:: https://img.shields.io/pypi/v/ansys-geometry-core.svg?logo=python&logoColor=white
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-geometry-core.svg?logo=python&logoColor=white&label=PyPI
    :target: https://pypi.org/project/ansys-geometry-core
    :alt: PyPI
 
-.. |downloads| image:: https://img.shields.io/pypi/dm/ansys-geometry-core.svg
+.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/ansys-geometry-core?label=Conda&logo=anaconda&logoColor=white
+   :target: https://anaconda.org/conda-forge/ansys-geometry-core
+   :alt: Conda
+
+.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/ansys-geometry-core.svg?label=PyPI%20downloads
    :target: https://pypi.org/project/ansys-geometry-core/
    :alt: PyPI Downloads
 
+.. |conda-downloads| image:: https://img.shields.io/conda/dn/conda-forge/ansys-geometry-core?label=Conda%20downloads
+   :target: https://anaconda.org/conda-forge/ansys-geometry-core
+   :alt: Conda Downloads
+
 .. |codecov| image:: https://codecov.io/gh/ansys/pyansys-geometry/graph/badge.svg?token=UZIC7XT5WE
    :target: https://codecov.io/gh/ansys/pyansys-geometry
    :alt: Codecov
@@ -54,6 +64,12 @@ You can use `pip <https://pypi.org/project/pip/>`_ to install PyAnsys Geometry.
 
     pip install ansys-geometry-core
 
+You can also install PyAnsys Geometry from `Conda-Forge <https://anaconda.org/conda-forge/ansys-geometry-core>`_:
+
+.. code:: bash
+
+   conda install -c conda-forge ansys-geometry-core
+
 To install the latest development version, run these commands:
 
 .. code:: bash
diff --git a/doc/changelog.d/1245.changed.md b/doc/changelog.d/1245.changed.md
@@ -0,0 +1 @@
+chore: update CHANGELOG for v0.6.0
diff --git a/doc/changelog.d/1246.changed.md b/doc/changelog.d/1246.changed.md
@@ -0,0 +1 @@
+chore: update dev version to 0.7.dev0
diff --git a/doc/changelog.d/1247.miscellaneous.md b/doc/changelog.d/1247.miscellaneous.md
@@ -0,0 +1 @@
+docs: add conda information for package
diff --git a/doc/changelog.d/1248.added.md b/doc/changelog.d/1248.added.md
@@ -0,0 +1 @@
+feat: revolve a sketch given an axis and an origin
diff --git a/doc/changelog.d/1250.dependencies.md b/doc/changelog.d/1250.dependencies.md
@@ -0,0 +1 @@
+build: bump protobuf from 5.27.0 to 5.27.1 in the grpc-deps group
diff --git a/doc/changelog.d/1251.dependencies.md b/doc/changelog.d/1251.dependencies.md
@@ -0,0 +1 @@
+build: bump the docs-deps group with 2 updates
diff --git a/doc/changelog.d/1252.dependencies.md b/doc/changelog.d/1252.dependencies.md
@@ -0,0 +1 @@
+build: bump trame-vtk from 2.8.8 to 2.8.9
diff --git a/doc/changelog.d/1253.dependencies.md b/doc/changelog.d/1253.dependencies.md
@@ -0,0 +1 @@
+build: bump pint from 0.23 to 0.24
diff --git a/doc/changelog.d/1254.dependencies.md b/doc/changelog.d/1254.dependencies.md
@@ -0,0 +1 @@
+build: bump ansys-tools-visualization-interface from 0.2.2 to 0.2.3
diff --git a/doc/changelog.d/1255.fixed.md b/doc/changelog.d/1255.fixed.md
@@ -0,0 +1 @@
+fix: Bug in `show` function
diff --git a/doc/source/_static/thumbnails/revolving.png b/doc/source/_static/thumbnails/revolving.png
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -269,6 +269,7 @@ def intersphinx_pyansys_geometry(switcher_version: str):
     "examples/03_modeling/boolean_operations": "_static/thumbnails/boolean_operations.png",
     "examples/03_modeling/scale_map_mirror_bodies": "_static/thumbnails/scale_map_mirror_bodies.png",  # noqa: E501
     "examples/03_modeling/sweep_chain_profile": "_static/thumbnails/sweep_chain_profile.png",
+    "examples/03_modeling/revolving": "_static/thumbnails/revolving.png",
     "examples/03_modeling/export_design": "_static/thumbnails/export_design.png",
     "examples/04_applied/01_naca_airfoils": "_static/thumbnails/naca_airfoils.png",
     "examples/04_applied/02_naca_fluent": "_static/thumbnails/naca_fluent.png",
diff --git a/doc/source/examples.rst b/doc/source/examples.rst
@@ -40,6 +40,7 @@ These examples demonstrate service-based modeling operations.
     examples/03_modeling/boolean_operations.mystnb
     examples/03_modeling/scale_map_mirror_bodies.mystnb
     examples/03_modeling/sweep_chain_profile.mystnb
+    examples/03_modeling/revolving.mystnb
     examples/03_modeling/export_design.mystnb
 
 Applied examples
diff --git a/doc/source/examples/03_modeling/revolving.mystnb b/doc/source/examples/03_modeling/revolving.mystnb
@@ -0,0 +1,126 @@
+---
+jupytext:
+  text_representation:
+    extension: .mystnb
+    format_name: myst
+    format_version: 0.13
+    jupytext_version: 1.14.1
+kernelspec:
+  display_name: Python 3 (ipykernel)
+  language: python
+  name: python3
+---
+
+# Modeling: Revolving a sketch
+
+This example shows how to use the ``revolve_sketch()`` method to
+revolve a sketch around an axis to create a 3D body. You can also
+specify the angle of revolution to create a partial body.
+
+```{code-cell} ipython3
+# Imports
+from ansys.geometry.core import Modeler
+from ansys.geometry.core.math import (
+  Plane,
+  Point2D,
+  Point3D,
+  UNITVECTOR3D_X,
+  UNITVECTOR3D_Z,
+)
+from ansys.geometry.core.misc import UNITS, Angle
+from ansys.geometry.core.sketch import Sketch
+
+```
+
+```{code-cell} ipython3
+# Initialize the modeler for this example notebook
+m = Modeler()
+```
+
+## Example: Creating a quarter of a donut
+
+The following code snippets show how to use the ``revolve_sketch()`` function to create a
+quarter of a 3D donut. The process involves defining a quarter of a circle as a profile
+and then revolving it around the Z-axis to create a 3D body.
+
+### Initialize the sketch design
+
+Create a design sketch named ``quarter-donut``.
+
+```{code-cell} ipython3
+# Initialize the donut sketch design
+design = m.create_design("quarter-donut")
+```
+
+### Define circle parameters
+
+Set ``path_radius``, which represents the radius of the circular path that the profile
+circle sweeps along, to ``5`` units.
+Set ``profile_radius``, which represents the radius of the profile circle that sweeps
+along the path to create the donut body, to ``2`` units.
+
+```{code-cell} ipython3
+# Donut parameters
+path_radius = 5
+profile_radius = 2
+```
+
+### Create the profile circle
+
+Create a circle on the XZ plane centered at the coordinates ``(5, 0, 0)``
+and use``profile_radius`` to define the radius. This circle serves as the
+profile or cross-sectional shape of the donut.
+
+```{code-cell} ipython3
+# Create the circular profile on the XZ-plane centered at (5, 0, 0)
+# with a radius of 2
+plane_profile = Plane(
+    origin=Point3D([path_radius, 0, 0]),
+    direction_x=UNITVECTOR3D_X,
+    direction_y=UNITVECTOR3D_Z,
+)
+profile = Sketch(plane=plane_profile)
+profile.circle(Point2D([0, 0]), profile_radius)
+
+profile.plot()
+```
+
+### Perform the revolve operation
+
+Revolve the profile circle around the Z axis to create a quarter of a donut body.
+Set the angle of revolution to 90 degrees in the default direction, which is counterclockwise.
+
+```{code-cell} ipython3
+# Revolve the profile around the Z axis and center in the absolute origin
+# for an angle of 90 degrees
+design.revolve_sketch(
+    "quarter-donut-body",
+    sketch=profile,
+    axis=UNITVECTOR3D_Z,
+    angle=Angle(90, unit=UNITS.degrees),
+    rotation_origin=Point3D([0, 0, 0]),
+)
+
+design.plot()
+```
+
+### Perform a revolve operation with a negative angle of revolution
+
+You can use a negative angle of revolution to create a quarter of a donut in the opposite direction. The following code snippet shows how to create a quarter of a donut in the clockwise direction. The same profile circle is used, but the angle of revolution is set to -90 degrees.
+
+```{code-cell} ipython3
+# Initialize the donut sketch design
+design = m.create_design("quarter-donut-negative")
+
+# Revolve the profile around the Z axis and center in the absolute origin
+# for an angle of -90 degrees (clockwise)
+design.revolve_sketch(
+    "quarter-donut-body-negative",
+    sketch=profile,
+    axis=UNITVECTOR3D_Z,
+    angle=Angle(-90, unit=UNITS.degrees),
+    rotation_origin=Point3D([0, 0, 0]),
+)
+
+design.plot()
+```
diff --git a/doc/source/examples/03_modeling/sweep_chain_profile.mystnb b/doc/source/examples/03_modeling/sweep_chain_profile.mystnb
@@ -75,7 +75,7 @@ defined by ``profile_radius``. This circle serves as the profile or cross-sectio
 shape of the donut.
 
 ```{code-cell} ipython3
-# Create the circlular profile on the XZ-plane centered at (5, 0, 0)
+# Create the circular profile on the XZ plane centered at (5, 0, 0)
 # with a radius of 2
 plane_profile = Plane(direction_x=UNITVECTOR3D_X, direction_y=UNITVECTOR3D_Z)
 profile = Sketch(plane=plane_profile)
@@ -90,7 +90,7 @@ Another circle, representing the path along which the profile circle is swept, i
 the XY-plane centered at (0, 0, 0). The radius of this circle is defined by ``path_radius``.
 
 ```{code-cell} ipython3
-# Create the circlular path on the XY-plane centered at (0, 0, 0) with radius 5
+# Create the circular path on the XY plane centered at (0, 0, 0) with radius 5
 path = [Circle(Point3D([0, 0, 0]), path_radius).trim(Interval(0, 2 * np.pi))]
 ```
 
diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst
@@ -4,7 +4,7 @@ Install package in development mode
 ###################################
 
 This topic assumes that you want to install PyAnsys Geometry in developer mode so that
-you can modify the source and enhance it. You can install PyAnsys Geometry from PyPI
+you can modify the source and enhance it. You can install PyAnsys Geometry from PyPI, Conda,
 or from the `PyAnsys Geometry repository <https://github.com/ansys/pyansys-geometry>`_ on GitHub.
 
 .. contents::
@@ -43,6 +43,23 @@ Then, to install PyAnsys Geometry, run this command:
 
    python -m pip install ansys-geometry-core
 
+
+Conda
+-----
+
+You can also install PyAnsys Geometry using `conda`_. First, ensure that you have the latest version:
+
+.. code:: bash
+
+   conda update -n base -c defaults conda
+
+Then, to install PyAnsys Geometry, run this command:
+
+.. code:: bash
+
+   conda install -c conda-forge ansys-geometry-core
+
+
 GitHub
 ------
 
@@ -77,7 +94,7 @@ For example, on Linux with Python 3.9, unzip the wheelhouse archive and install
 
 .. code:: bash
 
-    unzip ansys-geometry-core-v0.6.0-wheelhouse-Linux-3.9.zip wheelhouse
+    unzip ansys-geometry-core-v0.6.0-wheelhouse-ubuntu-3.9.zip wheelhouse
     pip install ansys-geometry-core -f wheelhouse --no-index --upgrade --ignore-installed
 
 If you are on Windows with Python 3.9, unzip the wheelhouse archive to a wheelhouse directory
@@ -116,3 +133,4 @@ For more information on PyAnsys Geometry usage, see :ref:`User guide <ref_user_g
 
 .. LINKS AND REFERENCES
 .. _pip: https://pypi.org/project/pip/
+.. _conda: https://conda.io/projects/conda/en/latest/user-guide/getting-started.html
diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt
@@ -1,6 +1,7 @@
 (?i)ansys
 (?i)api
 (?i)check
+[Cc]onda
 (?i)dependabot
 Direct API
 Dockerfile
diff --git a/pyproject.toml b/pyproject.toml
@@ -26,7 +26,7 @@ classifiers = [
 dependencies = [
     "ansys-api-geometry==0.4.4",
     "ansys-tools-path>=0.3,<1",
-    "ansys-tools-visualization-interface>=0.2.1,<1",
+    "ansys-tools-visualization-interface>=0.2.4,<1",
     "beartype>=0.11.0,<0.19",
     "grpcio>=1.35.0,<2",
     "grpcio-health-checking>=1.45.0,<2",
@@ -50,19 +50,19 @@ all = [
 tests = [
     "ansys-platform-instancemanagement==1.1.2",
     "ansys-tools-path==0.6.0",
-    "ansys-tools-visualization-interface==0.2.2",
+    "ansys-tools-visualization-interface==0.2.4",
     "beartype==0.18.5",
     "docker==7.1.0",
     "grpcio==1.64.1",
     "grpcio-health-checking==1.60.0",
     "numpy==1.26.4",
-    "Pint==0.23",
-    "protobuf==5.27.0",
+    "Pint==0.24",
+    "protobuf==5.27.1",
     "pytest==8.2.2",
     "pytest-cov==5.0.0",
     "pytest-pyvista==0.1.9",
     "pytest-xvfb==3.0.0",
-    "pyvista[jupyter]==0.43.8",
+    "pyvista[jupyter]==0.43.9",
     "requests==2.32.3",
     "scipy==1.13.1",
     "semver==3.0.2",
@@ -77,7 +77,7 @@ tests-minimal = [
 ]
 doc = [
     "ansys-sphinx-theme[autoapi]==0.16.5",
-    "ansys-tools-visualization-interface==0.2.2",
+    "ansys-tools-visualization-interface==0.2.4",
     "beartype==0.18.5",
     "docker==7.1.0",
     "ipyvtklink==0.2.3",
@@ -86,16 +86,16 @@ doc = [
     "myst-parser==3.0.1",
     "nbconvert==7.16.4",
     "nbsphinx==0.9.4",
-    "notebook==7.2.0",
+    "notebook==7.2.1",
     "numpydoc==1.7.0",
     "panel==1.4.4",
-    "pyvista[jupyter]==0.43.8",
+    "pyvista[jupyter]==0.43.9",
     "requests==2.32.3",
     "sphinx==7.3.7",
     "sphinx-autodoc-typehints==1.24.0",
     "sphinx-copybutton==0.5.2",
     "sphinx-jinja==2.0.2",
-    "trame-vtk==2.8.8",
+    "trame-vtk==2.8.9",
     "vtk==9.3.0",
 ]
 
diff --git a/src/ansys/geometry/core/designer/component.py b/src/ansys/geometry/core/designer/component.py
diff --git a/src/ansys/geometry/core/plotting/plotter.py b/src/ansys/geometry/core/plotting/plotter.py
diff --git a/tests/integration/image_cache/results/.gitignore b/tests/integration/image_cache/results/.gitignore
diff --git a/tests/integration/test_design.py b/tests/integration/test_design.py
diff --git a/tests/integration/test_plotter.py b/tests/integration/test_plotter.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+docs: add conda information for package`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+feat: revolve a sketch given an axis and an origin`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump protobuf from 5.27.0 to 5.27.1 in the grpc-deps group`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump the docs-deps group with 2 updates`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump trame-vtk from 2.8.8 to 2.8.9`