@@ -304,10 +304,11 @@ def launch_modeler_with_geometry_service(
304
304
By default its value is ``False``.
305
305
log_level : int, optional
306
306
Backend's log level from 0 to 3:
307
- 0: Chatterbox
308
- 1: Debug
309
- 2: Warning
310
- 3: Error
307
+
308
+ * ``0``: Chatterbox
309
+ * ``1``: Debug
310
+ * ``2``: Warning
311
+ * ``3``: Error
311
312
312
313
The default is ``2`` (Warning).
313
314
timeout : int, optional
@@ -339,8 +340,7 @@ def launch_modeler_with_geometry_service(
339
340
logs, traces enabled and a ``300`` seconds timeout:
340
341
341
342
>>> from ansys.geometry.core import launch_modeler_with_geometry_service
342
- >>> modeler = launch_modeler_with_geometry_service(product_version = 232,
343
- host="10.171.22.44",
343
+ >>> modeler = launch_modeler_with_geometry_service(host="10.171.22.44",
344
344
port=5001,
345
345
log_level=0,
346
346
enable_trace= True,
@@ -368,7 +368,11 @@ def launch_modeler_with_discovery(
368
368
"""
369
369
Start Ansys Discovery locally using the ``ProductInstance`` class.
370
370
371
- When calling this method, a standalone Geometry service is started.
371
+ .. note::
372
+
373
+ Support for Ansys Discovery is restricted to Ansys 24.1 onwards.
374
+
375
+ When calling this method, a standalone Discovery session is started.
372
376
By default, if an endpoint is specified (by defining `host` and `port` parameters)
373
377
but the endpoint is not available, the startup will fail. Otherwise, it will try to
374
378
launch its own service.
@@ -380,22 +384,23 @@ def launch_modeler_with_discovery(
380
384
the latest. Default is ``None``.
381
385
If a specific product version is requested but not installed locally,
382
386
a SystemError will be raised.
383
- Possible values:
384
- Ansys products Versions and their corresponding int values:
385
- 23.2 -> value : 232
386
- 24.1 -> value : 241
387
+
388
+ ** Ansys products versions and their corresponding int values:**
389
+
390
+ * ``241`` : Ansys 24R1
387
391
host: str, optional
388
- IP address at which the Geometry service will be deployed. By default,
392
+ IP address at which the Discovery session will be deployed. By default,
389
393
its value will be ``localhost``.
390
394
port : int, optional
391
395
Port at which the Geometry service will be deployed. By default, its
392
396
value will be ``None``.
393
397
log_level : int, optional
394
398
Backend's log level from 0 to 3:
395
- 0: Chatterbox
396
- 1: Debug
397
- 2: Warning
398
- 3: Error
399
+
400
+ * ``0``: Chatterbox
401
+ * ``1``: Debug
402
+ * ``2``: Warning
403
+ * ``3``: Error
399
404
400
405
The default is ``2`` (Warning).
401
406
api_version: ApiVersions, optional
@@ -460,7 +465,7 @@ def launch_modeler_with_spaceclaim(
460
465
"""
461
466
Start Ansys SpaceClaim locally using the ``ProductInstance`` class.
462
467
463
- When calling this method, a standalone Geometry service is started.
468
+ When calling this method, a standalone SpaceClaim session is started.
464
469
By default, if an endpoint is specified (by defining `host` and `port` parameters)
465
470
but the endpoint is not available, the startup will fail. Otherwise, it will try to
466
471
launch its own service.
@@ -472,22 +477,24 @@ def launch_modeler_with_spaceclaim(
472
477
the latest. Default is ``None``.
473
478
If a specific product version is requested but not installed locally,
474
479
a SystemError will be raised.
475
- Possible values:
476
- Ansys products Versions and their corresponding int values:
477
- 23.2 -> value : 232
478
- 24.1 -> value : 241
480
+
481
+ **Ansys products versions and their corresponding int values:**
482
+
483
+ * ``232`` : Ansys 23R2 SP1
484
+ * ``241`` : Ansys 24R1
479
485
host: str, optional
480
- IP address at which the Geometry service will be deployed. By default,
486
+ IP address at which the SpaceClaim session will be deployed. By default,
481
487
its value will be ``localhost``.
482
488
port : int, optional
483
489
Port at which the Geometry service will be deployed. By default, its
484
490
value will be ``None``.
485
491
log_level : int, optional
486
492
Backend's log level from 0 to 3:
487
- 0: Chatterbox
488
- 1: Debug
489
- 2: Warning
490
- 3: Error
493
+
494
+ * ``0``: Chatterbox
495
+ * ``1``: Debug
496
+ * ``2``: Warning
497
+ * ``3``: Error
491
498
492
499
The default is ``2`` (Warning).
493
500
api_version: ApiVersions, optional
0 commit comments