-
Notifications
You must be signed in to change notification settings - Fork 749
Update building from source instructions #1439
Conversation
With Qiskit/qiskit#7658 and Qiskit/qiskit#7702 not far behind the requiremetns for building terra from source will be changed. A C++ compiler is no longer required and instead a rust compiler is needed. This commit updates the instructions on building from source and also removes so old out of date notes from the document at the same time.
I think we probably should hold off on this until Qiskit/qiskit#7702 merges and we no longer depend on cython and only rust is required. |
Now that Qiskit/qiskit#7702 has merged I think we can move forward on this |
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 a couple of comments on the content, but it mostly all looks good to me.
|
||
xcode-select --install | ||
https://rustup.rs/ |
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 URL just ends up kind of awkwardly in its own paragraph - perhaps it'd be better to hyperlink the words "rustup, which is a cross-platform Rust installer"?
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 was trying to make the link pretty prominent instead of hidden behind a hyperlink since I expect most people reading this section will want to click it. I was worried a hyperlink wouldn't be super clear.
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.
Yeah, that's fair.
In Qiskit#1439 we updated the install from source documentation to reflect recent (as in the last year) changes to the build process and ensure the documentation was correct for installing from source. However, in Qiskit#1507 where some of the documentation was refactored these changes were inadvertadntly delete. This commit restores the correct source installation instructions from Qiskit#1439 so that the hosted docs correctly document how to build and install qiskit from source. Fixes Qiskit#1624
* Fix install from source docs In #1439 we updated the install from source documentation to reflect recent (as in the last year) changes to the build process and ensure the documentation was correct for installing from source. However, in #1507 where some of the documentation was refactored these changes were inadvertadntly delete. This commit restores the correct source installation instructions from #1439 so that the hosted docs correctly document how to build and install qiskit from source. Fixes #1624 * Update docs/getting_started.rst * Remove unnecessary pip install from aer instructions
) * Update building from source instructions With Qiskit#7658 and Qiskit#7702 not far behind the requiremetns for building terra from source will be changed. A C++ compiler is no longer required and instead a rust compiler is needed. This commit updates the instructions on building from source and also removes so old out of date notes from the document at the same time. * Apply suggestions from code review * Consistently capitalise "Rust" * Add section on modifying rust extension * Fix typos * Empty-Commit to retrigger ci after outage Co-authored-by: Jake Lishman <jake@binhbar.com>
* Fix install from source docs In Qiskit/qiskit-metapackage#1439 we updated the install from source documentation to reflect recent (as in the last year) changes to the build process and ensure the documentation was correct for installing from source. However, in Qiskit/qiskit-metapackage#1507 where some of the documentation was refactored these changes were inadvertadntly delete. This commit restores the correct source installation instructions from Qiskit/qiskit-metapackage#1439 so that the hosted docs correctly document how to build and install qiskit from source. Fixes Qiskit/qiskit-metapackage#1624 * Update docs/getting_started.rst * Remove unnecessary pip install from aer instructions
Summary
With Qiskit/qiskit#7658 and Qiskit/qiskit#7702 not far
behind the requiremetns for building terra from source will be changed.
A C++ compiler is no longer required and instead a rust compiler is
needed. This commit updates the instructions on building from source and
also removes some old out of date notes from the document at the same
time.
Details and comments