API reference#

This section describes PySherlock modules and their classes, methods, and functions. Use the search feature or click links to view API documentation.

ansys.sherlock.core.analysis

Module containing all analysis capabilities.

ansys.sherlock.core.types.analysis_types

Module containing types for the Analysis Service.

ansys.sherlock.core.common

Module for running the gRPC APIs in the Sherlock Common service.

ansys.sherlock.core.types.common_types

Module containing types for the Common Service.

ansys.sherlock.core.launcher

Module for launching Sherlock locally or connecting to a local instance with gRPC.

ansys.sherlock.core.layer

Module containing all layer management capabilities.

ansys.sherlock.core.types.layer_types

Module containing types for the Layer Service.

ansys.sherlock.core.lifecycle

Module containing all life cycle management capabilities.

ansys.sherlock.core.types.lifecycle_types

Module containing types for the Lifecycle Service.

ansys.sherlock.core.model

Module containing all model generation capabilities.

ansys.sherlock.core.parts

Module containing all parts management capabilities.

ansys.sherlock.core.types.parts_types

Module containing types for the Parts Service.

ansys.sherlock.core.project

Module containing all project management capabilities.

ansys.sherlock.core.types.project_types

Module containing types for the Project Service.

ansys.sherlock.core.stackup

Module containing all stackup management capabilities.