Skip to content

Commit

Permalink
docs: various improvements (#940)
Browse files Browse the repository at this point in the history
  • Loading branch information
RobPasMue authored Jan 19, 2024
1 parent ea28e4e commit a5c4672
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
11 changes: 9 additions & 2 deletions doc/source/getting_started/existing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------------

Expand All @@ -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.
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions doc/source/getting_started/local/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ 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

.. code:: python
from ansys.geometry.core import launch_modeler_with_spaceclaim
modeler_discovery = launch_modeler_with_spaceclaim()
modeler = launch_modeler_with_spaceclaim()
.. tab-item:: Geometry service

.. code:: python
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
Expand Down

0 comments on commit a5c4672

Please sign in to comment.