Skip to content
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

Document better the arguments "replace_env_vars" and "add_env_vars" #2309

Merged
merged 1 commit into from
Sep 5, 2023
Merged

Document better the arguments "replace_env_vars" and "add_env_vars" #2309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 18 additions & 4 deletions src/ansys/mapdl/core/launcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1115,13 +1115,15 @@ def launch_mapdl(
Default ``False``.

add_env_vars : dict, optional
The provided dictionary will be used to extend the system or process
The provided dictionary will be used to extend the MAPDL process
environment variables. If you want to control all of the environment
variables, use ``replace_env_vars``. Defaults to ``None``.
variables, use the argument ``replace_env_vars``. Defaults to ``None``.

replace_env_vars : dict, optional
The provided dictionary will be used to replace all the system or process
environment variables. To just add some environment variables to the MAPDL
The provided dictionary will be used to replace all the MAPDL process
environment variables. It replace the system environment variables
which otherwise would be used in the process.
To just add some environment variables to the MAPDL
process, use ``add_env_vars``. Defaults to ``None``.

version : float, optional
Expand Down Expand Up @@ -1307,6 +1309,18 @@ def launch_mapdl(
>>> mapdl = launch_mapdl('/ansys_inc/v194/ansys/bin/ansys194',
... mode='console')

Run MAPDL with additional environment variables.

>>> my_env_vars = {"my_var":"true", "ANSYS_LOCK":"FALSE"}
>>> mapdl = launch_mapdl(add_env_vars=my_env_vars)

Run MAPDL with our own set of environment variables. It replace the system
environment variables which otherwise would be used in the process.

>>> my_env_vars = {"my_var":"true",
"ANSYS_LOCK":"FALSE",
"ANSYSLMD_LICENSE_FILE":"1055@MYSERVER"}
>>> mapdl = launch_mapdl(replace_env_vars=my_env_vars)
"""
if remove_temp_files is not None:
warnings.warn(
Expand Down