Skip to content

Commit 297745e

Browse files
authored
Add ansys installation information in the docs (#67)
1 parent ccec2ad commit 297745e

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ PyDynamicReporting is licensed under the MIT license.
203203

204204
PyDynamicReporting makes no commercial claim over Ansys whatsoever.
205205
This library extends the functionality of Ansys Dynamic Reporting by
206-
adding a Python interface to Ansys Dynamic Reproting without changing
206+
adding a Python interface to Ansys Dynamic Reporting without changing
207207
the core behavior or license of the original software. The use of
208208
PyDynamicReporting requires a legally licensed copy of an Ansys product
209209
that supports Ansys Dynamic Reporting.

doc/.vale.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ WordTemplate = \b(?:%s)\b
2020
Packages = Google
2121

2222
# Define the Ansys vocabulary
23-
Vocab = ANSYS
23+
Vocab = ANSYS, Polyflow
2424

2525
[*.{md,rst}]
2626

doc/source/gettingstarted/index.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,22 @@ Getting started
33

44
PyDynamicReporting supports Ansys Dynamic Reporting 2023 R2 and later. To run
55
PyDynamicReporting, you must have either a local copy of an Ansys installation
6-
with a product that uses Ansys Dynamic Reporting or use a Docker image that
7-
PyDynamicReporting sets up for you.
6+
with a product that uses Ansys Dynamic Reporting or use a Docker image.
87

98
To get a copy of Ansys, visit the `Ansys <https://www.ansys.com/>`_ website.
109

10+
.. note::
11+
12+
Up to the Ansys 2023 R2 release, Ansys Dynamic Reporting is installed as
13+
part of the Ansys EnSight package, under the Fluids section of the
14+
installer. Starting from the Ansys 2024 R1 release, Ansys Dynamic Reporting
15+
is installed separately, and can be found in the Fluids section of the
16+
Ansys installer. Please also note that in all versions, Ansys Dynamic Reporting
17+
is automatically installed if one of the following Ansys products is
18+
installed: EnSight, Forte, Fluent, Polyflow, Icepack.
19+
20+
21+
1122
Installation
1223
~~~~~~~~~~~~
1324

@@ -18,7 +29,7 @@ To install the latest package from GitHub, run this command:
1829

1930
.. code::
2031
21-
pip install ansys-dynamicreporting-core
32+
pip install ansys-dynamicreporting-core
2233
2334
2435
If you plan on doing local *development* of PyDynamicReporting, install the

0 commit comments

Comments
 (0)