The ``ansys.geometry.core`` library
===================================
.. py:module:: ansys.geometry.core
Summary
-------
.. py:currentmodule:: core
.. tab-set::
.. tab-item:: Subpackages
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.geometry.core.connection`
- PyAnsys Geometry connection subpackage.
* - :py:obj:`~ansys.geometry.core.designer`
- PyAnsys Geometry designer subpackage.
* - :py:obj:`~ansys.geometry.core.materials`
- PyAnsys Geometry materials subpackage.
* - :py:obj:`~ansys.geometry.core.math`
- PyAnsys Geometry math subpackage.
* - :py:obj:`~ansys.geometry.core.misc`
- Provides the PyAnsys Geometry miscellaneous subpackage.
* - :py:obj:`~ansys.geometry.core.plotting`
- Provides the PyAnsys Geometry plotting subpackage.
* - :py:obj:`~ansys.geometry.core.shapes`
- Provides the PyAnsys Geometry ``geometry`` subpackage.
* - :py:obj:`~ansys.geometry.core.sketch`
- PyAnsys Geometry sketch subpackage.
* - :py:obj:`~ansys.geometry.core.tools`
- PyAnsys Geometry tools subpackage.
.. tab-item:: Submodules
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.geometry.core.errors`
- Provides PyAnsys Geometry-specific errors.
* - :py:obj:`~ansys.geometry.core.logger`
- Provides a general framework for logging in PyAnsys Geometry.
* - :py:obj:`~ansys.geometry.core.modeler`
- Provides for interacting with the Geometry service.
* - :py:obj:`~ansys.geometry.core.typing`
- Provides typing of values for PyAnsys Geometry.
.. tab-item:: Attributes
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~__version__`
- PyAnsys Geometry version.
.. tab-item:: Constants
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~USE_SERVICE_COLORS`
- Global constant for checking whether to use service colors for plotting
* - :py:obj:`~DISABLE_MULTIPLE_DESIGN_CHECK`
- Global constant for disabling the ``ensure_design_is_active`` check.
* - :py:obj:`~DOCUMENTATION_BUILD`
- Global flag for the documentation to use the proper PyVista Jupyter backend.
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
connection
designer
materials
math
misc
plotting
shapes
sketch
tools
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
errors
logger
modeler
typing
Description
-----------
PyAnsys Geometry is a Python wrapper for the Ansys Geometry service.
..
!! processed by numpydoc !!
Module detail
-------------
.. py:data:: USE_SERVICE_COLORS
:type: bool
:value: 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).
..
!! processed by numpydoc !!
.. py:data:: DISABLE_MULTIPLE_DESIGN_CHECK
:type: bool
:value: 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 you will ONLY be working with one design.
..
!! processed by numpydoc !!
.. py:data:: DOCUMENTATION_BUILD
:type: bool
Global flag for the documentation to use the proper PyVista Jupyter backend.
..
!! processed by numpydoc !!
.. py:data:: __version__
PyAnsys Geometry version.
..
!! processed by numpydoc !!