The ansys.geometry.core library

Summary

Subpackages

connection	PyAnsys Geometry connection subpackage.
designer	PyAnsys Geometry designer subpackage.
materials	PyAnsys Geometry materials subpackage.
math	PyAnsys Geometry math subpackage.
misc	Provides the PyAnsys Geometry miscellaneous subpackage.
parameters	PyAnsys Geometry parameters subpackage.
plotting	Provides the PyAnsys Geometry plotting subpackage.
shapes	Provides the PyAnsys Geometry geometry subpackage.
sketch	PyAnsys Geometry sketch subpackage.
tools	PyAnsys Geometry tools subpackage.

Submodules

errors	Provides PyAnsys Geometry-specific errors.
logger	Provides a general framework for logging in PyAnsys Geometry.
modeler	Provides for interacting with the Geometry service.
typing	Provides typing of values for PyAnsys Geometry.

Attributes

__version__

PyAnsys Geometry version.

Constants

USE_SERVICE_COLORS	Global constant for checking whether to use service colors for plotting
DISABLE_MULTIPLE_DESIGN_CHECK	Deprecated constant. Use DISABLE_ACTIVE_DESIGN_CHECK instead.
DISABLE_ACTIVE_DESIGN_CHECK	Global constant for disabling the ensure_design_is_active check.
DOCUMENTATION_BUILD	Global flag for the documentation to use the proper PyVista Jupyter backend.
USE_TRACKER_TO_UPDATE_DESIGN	Global constant for checking whether to use the tracker to update designs.
ENABLE_RUNTIME_TYPECHECKING	Global flag for enabling runtime type checking on public API methods.

Description

PyAnsys Geometry is a Python wrapper for the Ansys Geometry service.

Module detail

ansys.geometry.core.USE_SERVICE_COLORS: bool = False

Global constant for checking whether to use service colors for plotting purposes. If set to False, the default colors will be used (speed gain).

ansys.geometry.core.DISABLE_MULTIPLE_DESIGN_CHECK: bool = True

Deprecated constant. Use DISABLE_ACTIVE_DESIGN_CHECK instead.

ansys.geometry.core.DISABLE_ACTIVE_DESIGN_CHECK: bool = False

Global constant for disabling the ensure_design_is_active check.

Only set this to false if you are sure you want to disable this check and your objects will always exist on the server side.

ansys.geometry.core.DOCUMENTATION_BUILD: bool

Global flag for the documentation to use the proper PyVista Jupyter backend.

ansys.geometry.core.USE_TRACKER_TO_UPDATE_DESIGN: bool = False

Global constant for checking whether to use the tracker to update designs.

ansys.geometry.core.ENABLE_RUNTIME_TYPECHECKING: bool = False

Global flag for enabling runtime type checking on public API methods.

When True, all methods decorated with @check_input_types will perform runtime type validation, and all check_* helper functions will execute their validation logic. This is useful for debugging type errors, but comes with a runtime performance cost. When False (default), type checking is skipped for maximum performance.

To enable:

import ansys.geometry.core as pyansys_geometry
pyansys_geometry.ENABLE_RUNTIME_TYPECHECKING = True

ansys.geometry.core.__version__

PyAnsys Geometry version.