Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Update building from source instructions #1439

Merged
merged 9 commits into from
Mar 23, 2022

Conversation

mtreinish
Copy link
Member

@mtreinish mtreinish commented Mar 1, 2022

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

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.
@mtreinish mtreinish added the on hold Can not fix yet label Mar 1, 2022
@mtreinish
Copy link
Member Author

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.

docs/contributing_to_qiskit.rst Outdated Show resolved Hide resolved
docs/contributing_to_qiskit.rst Outdated Show resolved Hide resolved
docs/contributing_to_qiskit.rst Outdated Show resolved Hide resolved
docs/contributing_to_qiskit.rst Outdated Show resolved Hide resolved
@mtreinish mtreinish removed the on hold Can not fix yet label Mar 11, 2022
@mtreinish
Copy link
Member Author

Now that Qiskit/qiskit#7702 has merged I think we can move forward on this

@mtreinish mtreinish requested a review from jakelishman March 11, 2022 16:34
Copy link
Member

@jakelishman jakelishman left a 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.

docs/contributing_to_qiskit.rst Outdated Show resolved Hide resolved

xcode-select --install
https://rustup.rs/
Copy link
Member

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"?

Copy link
Member Author

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's fair.

docs/contributing_to_qiskit.rst Show resolved Hide resolved
docs/contributing_to_qiskit.rst Outdated Show resolved Hide resolved
docs/contributing_to_qiskit.rst Outdated Show resolved Hide resolved
@mtreinish mtreinish merged commit 752afc1 into Qiskit:master Mar 23, 2022
@mtreinish mtreinish deleted the update-install-docs-terra branch March 23, 2022 23:21
mtreinish added a commit to mtreinish/qiskit that referenced this pull request Oct 31, 2022
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
mergify bot pushed a commit that referenced this pull request Nov 1, 2022
* 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
jakelishman added a commit to jakelishman/qiskit-terra that referenced this pull request Aug 11, 2023
)

* 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>
jakelishman pushed a commit to jakelishman/qiskit-terra that referenced this pull request Aug 11, 2023
* 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
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants