From 297745eb908c6e81c7c7866e942e85f9ff777793 Mon Sep 17 00:00:00 2001 From: Marina Galvagni <96880748+margalva@users.noreply.github.com> Date: Tue, 10 Oct 2023 10:23:32 -0400 Subject: [PATCH] Add ansys installation information in the docs (#67) --- README.rst | 2 +- doc/.vale.ini | 2 +- doc/source/gettingstarted/index.rst | 17 ++++++++++++++--- 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 1e171c30..ad489084 100644 --- a/README.rst +++ b/README.rst @@ -203,7 +203,7 @@ PyDynamicReporting is licensed under the MIT license. PyDynamicReporting makes no commercial claim over Ansys whatsoever. This library extends the functionality of Ansys Dynamic Reporting by -adding a Python interface to Ansys Dynamic Reproting without changing +adding a Python interface to Ansys Dynamic Reporting without changing the core behavior or license of the original software. The use of PyDynamicReporting requires a legally licensed copy of an Ansys product that supports Ansys Dynamic Reporting. diff --git a/doc/.vale.ini b/doc/.vale.ini index f4f8b29e..fad4ddd3 100644 --- a/doc/.vale.ini +++ b/doc/.vale.ini @@ -20,7 +20,7 @@ WordTemplate = \b(?:%s)\b Packages = Google # Define the Ansys vocabulary -Vocab = ANSYS +Vocab = ANSYS, Polyflow [*.{md,rst}] diff --git a/doc/source/gettingstarted/index.rst b/doc/source/gettingstarted/index.rst index c6a1fb1a..2c26785f 100755 --- a/doc/source/gettingstarted/index.rst +++ b/doc/source/gettingstarted/index.rst @@ -3,11 +3,22 @@ Getting started PyDynamicReporting supports Ansys Dynamic Reporting 2023 R2 and later. To run PyDynamicReporting, you must have either a local copy of an Ansys installation -with a product that uses Ansys Dynamic Reporting or use a Docker image that -PyDynamicReporting sets up for you. +with a product that uses Ansys Dynamic Reporting or use a Docker image. To get a copy of Ansys, visit the `Ansys `_ website. +.. note:: + + Up to the Ansys 2023 R2 release, Ansys Dynamic Reporting is installed as + part of the Ansys EnSight package, under the Fluids section of the + installer. Starting from the Ansys 2024 R1 release, Ansys Dynamic Reporting + is installed separately, and can be found in the Fluids section of the + Ansys installer. Please also note that in all versions, Ansys Dynamic Reporting + is automatically installed if one of the following Ansys products is + installed: EnSight, Forte, Fluent, Polyflow, Icepack. + + + Installation ~~~~~~~~~~~~ @@ -18,7 +29,7 @@ To install the latest package from GitHub, run this command: .. code:: - pip install ansys-dynamicreporting-core + pip install ansys-dynamicreporting-core If you plan on doing local *development* of PyDynamicReporting, install the