-
Notifications
You must be signed in to change notification settings - Fork 95
Updated the doc from libgomp to libomp.
#427
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.
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
Conversation
|
Please review. |
cgranade
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to make sure that this doesn't get accidentally merged in before the other PRs are ready, leaving as a comment rather than approving for now.
articles/install-command-line-qdk.md
Outdated
| > [!IMPORTANT] | ||
| > If you are working on Linux, you may encounter a missing dependency depending on your particular distribution and installation method (such as certain Docker images). Please make sure that the `libgomp` library is installed on your system, as the GNU OpenMP support library is required by the quantum simulator of the QDK. On Ubuntu, you can do so by running `sudo apt install libgomp1`, or `yum install libgomp` on CentOS. For other distributions, please refer to your particular package manager. | ||
| > If you are working on Linux, you may encounter a missing dependency depending on your particular distribution and installation method (such as certain Docker images). Please make sure that the `libomp` library is installed on your system, as the OpenMP support library is required by the quantum simulator of the QDK. On Ubuntu, you can do so by running `sudo apt install libomp5-11`, or `yum install libomp` on CentOS. For other distributions, please refer to your particular package manager. | ||
| On MacOS you can install `libomp` by running `brew install libomp`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it OK to assume that macOS users have brew available?
[nit] Apple uses the capitalization "macOS."
| On MacOS you can install `libomp` by running `brew install libomp`. | |
| On macOS you can install `libomp` by running `brew install libomp`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it OK to assume that macOS users have
brewavailable?
I'm not very experienced in macOS but I would expect that "Yes", since anything that gets installed on macOS is mostly installed with brew (same as on some distros of Linux everything is mostly installed with apt).
Apple uses the capitalization "macOS."
Fixing...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the difference is that apt is an official part of most Linux distributions, while brew is a very popular third-party tool for macOS. I have no objection to listing brew, but we may want to give context around what it is, or at least to have fallback for users without brew. By analogy, we give conda-based instructions as well as pip+dotnet instructions as a fallback.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To move forward I plan to leave the change as is for now. Feel free to provide a desired change and I'll update this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cgranade Do you want to suggest an edit to add a sentence?
|
@cgranade Please review this PR again and merge it if it looks good. Thank you. |
3393065 to
6840e59
Compare
|
Please review again and/or approve. |
articles/how-to-python-qdk-local.md
Outdated
| > [!NOTE] | ||
| > If you hit an error `Unable to load shared library 'Microsoft.Quantum.Simulator.Runtime' or one of its dependencies`, then you need to install the `libomp` library, as the OpenMP support library is required by the quantum simulator of the QDK. On Ubuntu, you can do so by running `sudo apt install libomp5-11`, or `yum install libomp` on CentOS. For other distributions, please refer to your particular package manager. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'then you need to install' - I'd think that this is only one of the possible reasons for getting 'Unable to load'. So I suggest something like "then you may be missing libomp, as the OpenMP..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, changed.
articles/how-to-python-qdk-local.md
Outdated
| > [!NOTE] | ||
| > If you hit an error `Unable to load shared library 'Microsoft.Quantum.Simulator.Runtime' or one of its dependencies`, then you need to install the `libomp` library, as the OpenMP support library is required by the quantum simulator of the QDK. On Ubuntu, you can do so by running `sudo apt install libomp5-11`, or `yum install libomp` on CentOS. For other distributions, please refer to your particular package manager. | ||
| On macOS you can install `libomp` by running `brew install libomp`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to be one of the possibilities along with Ubuntu and CentOS, yet it's a separate sentence. I suggest saying something like:
You can install 'libomp' by running '...' on Ubuntu, '...' on Cent OS, '..' on macOS. For other distributions...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed.
articles/install-command-line-qdk.md
Outdated
| > [!IMPORTANT] | ||
| > If you are working on Linux, you may encounter a missing dependency depending on your particular distribution and installation method (such as certain Docker images). Please make sure that the `libgomp` library is installed on your system, as the GNU OpenMP support library is required by the quantum simulator of the QDK. On Ubuntu, you can do so by running `sudo apt install libgomp1`, or `yum install libgomp` on CentOS. For other distributions, please refer to your particular package manager. | ||
| > If you are working on Linux, you may encounter a missing dependency depending on your particular distribution and installation method (such as certain Docker images). Please make sure that the `libomp` library is installed on your system, as the OpenMP support library is required by the quantum simulator of the QDK. On Ubuntu, you can do so by running `sudo apt install libomp5-11`, or `yum install libomp` on CentOS. For other distributions, please refer to your particular package manager. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same suggestions here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed.
|
Please review and/or approve. |
A complement to the set of 3 PRs: Q#RT, QDK, IQ# repos.