add docs

ansys · Feb 4, 2025 · 1ae55fe · 1ae55fe
1 parent 70b5b81
commit 1ae55fe
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/doc/source/getting_started/local/index.rst b/doc/source/getting_started/local/index.rst
@@ -35,6 +35,8 @@ either Discovery, SpaceClaim, or the Geometry service.
 
           modeler = launch_modeler_with_geometry_service()
 
+When launching via Geometry Service, if you have a custom local install, you can define the path of this install
+in the ANSYS_GEOMETRY_SERVICE_ROOT environment variable. The launcher will use this location by default.
 
 For more information on the arguments accepted by the launcher methods, see
 their API documentation:

diff --git a/src/ansys/geometry/core/connection/product_instance.py b/src/ansys/geometry/core/connection/product_instance.py
@@ -143,6 +143,7 @@
 """
 
 ANSYS_GEOMETRY_SERVICE_ROOT = "ANSYS_GEOMETRY_SERVICE_ROOT"
+"""Local Geometry Service install location. This is for GeometryService and CoreGeometryService."""
 
 
 class ProductInstance:
-Original file line number
+Diff line change
@@ Expand Up / @@ -143,6 +143,7 @@ @@
     """
     ANSYS_GEOMETRY_SERVICE_ROOT = "ANSYS_GEOMETRY_SERVICE_ROOT"
+    """Local Geometry Service install location. This is for GeometryService and CoreGeometryService."""
     class ProductInstance:
@@ Expand Down @@