diff --git a/doc/source/getting_started/existing/index.rst b/doc/source/getting_started/existing/index.rst index 82b93ff510..b099a5f1d9 100644 --- a/doc/source/getting_started/existing/index.rst +++ b/doc/source/getting_started/existing/index.rst @@ -6,6 +6,13 @@ Use an existing session If a session of Discovery, SpaceClaim, or the Geometry service is already running, PyAnsys Geometry can be used to connect to it. +.. warning:: + + Running a SpaceClaim or Discovery normal session will not suffice to be + able to use it with PyAnsys Geometry. Both products need the ApiServer extension to be + running. In this case, we recommend users to launch the products directly from the PyAnsys + Geometry library as shown in :ref:`ref_creating_local_session` to ease the process. + Establish the connection ------------------------ @@ -15,7 +22,7 @@ From Python, establish a connection to the existing client session by creating a from ansys.geometry.core import Modeler - modeler = Modeler(host="localhost", port=5001) + modeler = Modeler(host="localhost", port=50051) If no error messages are received, your connection is established successfully. Note that your local port number might differ from the one shown in the preceding code. @@ -29,7 +36,7 @@ connection inside your ``Modeler`` object: >>> modeler.client Ansys Geometry Modeler Client (...) - Target: localhost:5001 + Target: localhost:50051 Connection: Healthy .. button-ref:: ../index diff --git a/doc/source/getting_started/local/index.rst b/doc/source/getting_started/local/index.rst index 3c2ec463d0..fd73632571 100644 --- a/doc/source/getting_started/local/index.rst +++ b/doc/source/getting_started/local/index.rst @@ -17,7 +17,7 @@ either Discovery, SpaceClaim, or the Geometry service. from ansys.geometry.core import launch_modeler_with_discovery - modeler_discovery = launch_modeler_with_discovery() + modeler = launch_modeler_with_discovery() .. tab-item:: SpaceClaim @@ -25,7 +25,7 @@ either Discovery, SpaceClaim, or the Geometry service. from ansys.geometry.core import launch_modeler_with_spaceclaim - modeler_discovery = launch_modeler_with_spaceclaim() + modeler = launch_modeler_with_spaceclaim() .. tab-item:: Geometry service @@ -33,7 +33,7 @@ either Discovery, SpaceClaim, or the Geometry service. from ansys.geometry.core import launch_modeler_with_geometry_service - modeler_discovery = launch_modeler_with_geometry_service() + modeler = launch_modeler_with_geometry_service() For more information on the arguments accepted by the launcher methods, see