Documentation Improvements + Python Installation QoL#402
Open
wavefunction91 wants to merge 5 commits intomainfrom
Open
Documentation Improvements + Python Installation QoL#402wavefunction91 wants to merge 5 commits intomainfrom
wavefunction91 wants to merge 5 commits intomainfrom
Conversation
wavefunction91
requested review from
ConradJohnston,
nabbelbabbel and
sobolevnrm
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves documentation and installation experience by adding prerequisite instructions to example notebooks, a version compatibility note, and a per-example dependency table in the examples README. It also adds the jupyter extra to the all optional-dependencies group and removes a now-redundant openfermion install instruction.
Changes:
- Added
jupyterto theallextras group inpyproject.tomland updated install docs to remove redundantopenfermionmention. - Added prerequisite/install instructions to example notebooks and a version compatibility note to the quickstart docs.
- Expanded
examples/README.mdwith a per-example dependency table and version compatibility guidance.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| python/pyproject.toml | Added jupyter to the all extras group |
| examples/state_prep_energy.ipynb | Added prerequisites section with jupyter extra install |
| examples/qpe_stretched_n2.ipynb | Updated install instructions to use jupyter extra |
| examples/factory_list.ipynb | Added prerequisites section with plugins extra install |
| examples/README.md | Added version compatibility note and per-example dependency table |
| docs/source/user/quickstart.rst | Added note about using stable branch for PyPI installs |
| INSTALL.md | Added cross-reference to examples README; removed redundant openfermion install |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📊 Coverage Summary
Detailed Coverage ReportsC++ Coverage DetailsPython Coverage DetailsPybind11 Coverage Details |
sobolevnrm
reviewed
Mar 16, 2026
sobolevnrm
previously approved these changes
Mar 16, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves documentation and installation experience by adding a jupyter extra to the [all] dependency group, updating example notebooks with prerequisite instructions, adding version compatibility guidance, and cleaning up redundant installation instructions (removing direct openfermion install references since it's covered by the extras).
Changes:
- Added
jupyterto the[all]optional dependency group and updated notebooks to referenceqdk-chemistry[jupyter]instead of manualpip installof individual packages. - Added version compatibility notes (use
stable/major.minorbranch for PyPI installs) to the examples README and quickstart docs. - Removed redundant direct-install instructions for
openfermionacross docs and devcontainer scripts.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
python/pyproject.toml |
Added jupyter to the all extras group |
examples/state_prep_energy.ipynb |
Added prerequisites section referencing jupyter extra |
examples/qpe_stretched_n2.ipynb |
Updated install instructions to use jupyter extra |
examples/factory_list.ipynb |
Added prerequisites section referencing plugins extra |
examples/README.md |
Added version compatibility note and per-example install table |
docs/source/user/quickstart.rst |
Added version compatibility note (has syntax issues) |
docs/source/user/comprehensive/plugins.rst |
Removed redundant direct openfermion install instructions |
INSTALL.md |
Updated to reference examples README; removed openfermion from manual install |
.devcontainer/scripts/venv.sh |
Removed openfermion from manual pip install |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+30
to
+33
| ```bash | ||
| git clone --branch stable/1.0 qdk-chemistry | ||
| ``` | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.