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

Jump to bottom

Add clarification about setting env vars prior to setting target #2173

Merged
merged 2 commits into from
Aug 29, 2024
Merged

Add clarification about setting env vars prior to setting target #2173

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb5799c
Add clarification about setting env vars prior to setting target
bmhowe23 Aug 29, 2024
a9d4817
Merge branch 'main' into pr-clarify-docs-env-var
bmhowe23 Aug 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
Next Next commit
Add clarification about setting env vars prior to setting target
  • Loading branch information
@bmhowe23
bmhowe23 committed Aug 29, 2024
commit fb5799c34e4d09aaf85f9e228828d78416f3b79b
7 changes: 5 additions & 2 deletions docs/sphinx/using/backends/simulators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,9 @@ use `cudaq.set_target('nvidia', option='fp64')` for Python in-source target modi

This backend requires an NVIDIA GPU and CUDA runtime libraries. If you do not have these dependencies installed, you may encounter an error stating `Invalid simulator requested`. See the section :ref:`dependencies-and-compatibility` for more information about how to install dependencies.

In the single-GPU mode, the :code:`nvidia` target provides the following environment variable options.
In the single-GPU mode, the :code:`nvidia` target provides the following
environment variable options. Any environment variables must be set prior to
setting the target.

.. list-table:: **Environment variable options supported in single-GPU mode**
:widths: 20 30 50
Expand Down Expand Up @@ -199,7 +201,8 @@ To execute a program on the multi-node multi-GPU NVIDIA target, use the followin

In addition to those environment variable options supported in the single-GPU mode,
the :code:`nvidia` target provides the following environment variable options particularly for
the multi-node multi-GPU configuration.
the multi-node multi-GPU configuration. Any environment variables must be set
prior to setting the target.

.. list-table:: **Additional environment variable options for multi-node multi-GPU mode**
:widths: 20 30 50
Expand Down
Loading