Skip to content

Commit f3ee132

Browse files
docs: document version compatibility in the installation instructions (#571)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 8fe1273 commit f3ee132

File tree

4 files changed

+27
-6
lines changed

4 files changed

+27
-6
lines changed

CONTRIBUTORS.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,8 @@
1616
* [ansznavarro](https://github.com/ansznavarro)
1717
* [Jeff Moody](https://github.com/ansjmoody)
1818
* [Jorge Martínez](https://github.com/jorgepiloto)
19-
* [Joshua Moody](https://github.com/jmoody)
2019
* [Kathy Pippert](https://github.com/PipKat)
2120
* [Keith Hanson](https://github.com/anskhanson)
22-
* [khanson](https://github.com/khanson)
2321
* [Maxime Rey](https://github.com/MaxJPRey)
2422
* [Miu Lin Edson](https://github.com/ansmedson-ext)
2523
* [Nayane Fernandes](https://github.com/ansnfernand)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs: document version compatibility in the installation instructions

doc/source/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ archive from the `Releases Page <https://github.com/ansys/pysherlock/releases>`_
171171
corresponding machine architecture.
172172

173173
Each wheelhouse archive contains all the Python wheels necessary to install PySherlock from scratch on Windows,
174-
Linux, and MacOS from Python 3.10 to 3.12. You can install this on an isolated system with a fresh Python
174+
Linux, and MacOS from Python 3.10 to 3.13. You can install this on an isolated system with a fresh Python
175175
installation or on a virtual environment.
176176

177177
For example, on Linux with Python 3.10, unzip the wheelhouse archive and install it with:

doc/source/getting_started/installation.rst

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,39 @@
44
Install packages
55
================
66

7-
The ``ansys-sherlock-core`` package supports Python 3.10 through Python 3.12 on Windows.
7+
The ``ansys-sherlock-core`` package supports Python 3.10 through Python 3.13 on Windows and Linux.
88

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

1414
.. code::
1515
1616
pip install ansys-sherlock-core
1717
18+
The following table shows the version of PySherlock to use for each release of Sherlock:
19+
20+
+------------+----------+
21+
| PySherlock | Sherlock |
22+
+============+==========+
23+
| 0.4 | 2024 R1 |
24+
+------------+----------+
25+
| 0.6 | 2024 R2 |
26+
+------------+----------+
27+
| 0.8 | 2025 R1 |
28+
+------------+----------+
29+
| 0.9 | 2025 R2 |
30+
+------------+----------+
31+
32+
To install a specific version of PySherlock, use the following command, where the <version> is one
33+
of the values in the table above:
34+
35+
.. code::
36+
37+
pip install ansys-sherlock-core==<version>
38+
39+
1840
If you want to install the ``ansys-api-sherlock`` and ``ansys-sherlock-core`` packages
1941
from its source code directly, follow these instructions.
2042

0 commit comments

Comments
 (0)