Skip to main content
PySherlock

PyAnsys Python PyPI GH-CI Codecov MIT Black

PySherlock is a Python client library for the Ansys Sherlock product.

Overview

Ansys Sherlock is a reliability physics-based electronics design tool that provides fast and accurate life predictions for electronic hardware at the component, board, and system levels in early stage design.

PySherlock provides Pythonic access to Sherlock’s functions, enabling users to automate and customize their specific workflows.

With PySherlock, you can perform many tasks, including these:

  • Launch a Sherlock gRPC server and a Sherlock client.

  • Import ECAD files and generate project reports.

  • Define life cycle events and profiles.

  • Generate a stackup and update a stackup layer.

  • Update a project parts list.

  • Perform layer view operations such as updating a mount point’s location.

  • Export a trace or trace reinforcement model for integration with Ansys Workbench.

  • Execute one or more analyses.

Dependencies

You must have a licensed copy of Ansys Sherlock installed either on your local machine or a remote machine. To use a remote session, a connection to the remote machine must be available from your Python program.

Getting Started

PySherlock uses an environment variable called AWP_ROOT<ver>, where <ver> is the Sherlock release number, such as 242 for release 2024 R2. Each release version should have its own environment variable. This variable is how PySherlock finds a Sherlock installation for a specific version. If there are multiple versions, PySherlock will pick the latest.

On a Windows System, the environment variable AWP_ROOT<ver> is configured by the Ansys installer.

On a Linux system, the AWP_ROOT<ver> environment variable must be configured by the user. It must point to the absolute path of an Ansys installation directory. For example, if Sherlock 24R2 is installed in the following location /opt/ansys_inc/v242/sherlock/ , then an environment variable named AWP_ROOT242 must be created and set to /opt/ansys_inc/v242/. If there are multiple versions of Ansys tools installed, similar environment variables must be created for those versions.

For the rest of the setup please refer to the tutorial videos below.

Documentation and issues

For comprehensive information on PySherlock, see the latest release documentation.

On the PySherlock Issues page, you can create issues to submit questions, report bugs, and request new features. This is the best place to post questions and code.

Contributing

If you would like to test or contribute to the development of PySherlock, see Contribute in the PySherlock documentation.

License

PySherlock is licensed under the MIT license.

PySherlock makes no commercial claim over Ansys whatsoever. This library extends the functionality of Ansys Sherlock by adding a Python interface to Sherlock without changing the core behavior or license of the original software. The use of the interactive control of PySherlock requires a legally licensed copy of Sherlock.

For more information on Sherlock, see the Ansys Sherlock page on the Ansys website.

Metadata

Release files for ansys-sherlock-core 2.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansys-sherlock-core 2.1.5
File Size Uploaded Provenance Actions
ansys_sherlock_core-2.1.5.tar.gz 102.5 kB With provenance Details for ansys_sherlock_core-2.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ansys-sherlock-core 2.1.5
File Interpreter ABI Platform Actions
ansys_sherlock_core-2.1.5-py3-none-any.whl Python 3 none any Details for ansys_sherlock_core-2.1.5-py3-none-any.whl

Total release size: 223.4 kB

Release files / ansys_sherlock_core-2.1.5.tar.gz

Download URL ansys_sherlock_core-2.1.5.tar.gz
Size 102.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a8b928e93d3f0eac3158209fcc3493d98e87fa93dadbf7f417dd18c0c8bb62e9
BLAKE2b-256 checksum
How to use checksums
15f3ab12aafcaa31439d19fb3bdd1d3a0e30f4dd52200536d7e22e42d358a6cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Release files / ansys_sherlock_core-2.1.5-py3-none-any.whl

Download URL ansys_sherlock_core-2.1.5-py3-none-any.whl
Size 120.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2140a17bcd5a988a2c3e1cd31014dbed1419ee2f9014a190c19de6e3f5275f11
BLAKE2b-256 checksum
How to use checksums
b6b98cae8650273ee9f3e7a4fdad0dd67b6a1a52eb2d100601dfbb09d89242ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Security for ansys-sherlock-core 2.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ansys_sherlock_core-2.1.5.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page