Install packages

The ansys-sherlock-core package supports Python 3.10 through Python 3.12 on Windows.

To use PySherlock, you must download and install both the ansys-api-sherlock and ansys-sherlock-core packages. By using pip, ansys-api-sherlock is installed as part of ansys-sherlock-core. Run the following to install the publicly distributed version of the package.

pip install ansys-sherlock-core

If you want to install the ansys-api-sherlock and ansys-sherlock-core packages from its source code directly, follow these instructions.

1. Download the latest ansys-api-sherlock package by running this git clone command:

   git clone https://github.com/ansys/ansys-api-sherlock.git
   

   Alternatively, you can download the ZIP file from the Release area of the ansys-api-sherlock GitHub repository and unzip it before proceeding with the installation.

2. After the package is downloaded, execute these commands to install it:

   cd ansys-api-sherlock
   pip install -e .
   

3. Download the latest ansys-sherlock-core package by running this git clone command:

   git clone https://github.com/ansys/pysherlock.git
   

   Alternatively, you can download the ZIP file from the Release area of the pysherlock GitHub repository and unzip it before proceeding with the installation.

4. After the package is downloaded, execute these commands to install it:

   cd pysherlock
   pip install -e .