Skip to content

Linux Sherlock Launcher, environment variables #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Linux Sherlock Launcher, environment variables #344

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45d1637
Added instructions for setting up the environment variables for linux…
anskhanson Jul 26, 2024
8cdb2db
Increased underline size under "Getting Started" section.
anskhanson Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,26 @@ You must have a licensed copy of `Ansys Sherlock <https://www.ansys.com/products
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.

* `PySherlock Installation and Usage Demo | Step-by-Step Guide for Beginners <https://www.youtube.com/watch?v=ugiueYuNEKk>`_
* `PySherlock Installation and Usage Demo | Advanced Setup Guide <https://www.youtube.com/watch?v=06s_tNvlOTM>`_

Documentation and issues
------------------------
For comprehensive information on PySherlock, see the latest release
Expand Down