Skip to content

Add info on generating package info locally #4838

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

Open
abbycross wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add info on generating package info locally #4838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,11 @@ If you don't do this step, you will get the error "FAILED scripts/nb-tester/test
### Add package version information

Add a new markdown cell under your title with a `version-info` tag.
When you execute the notebook (see the next section), the script will populate
When you execute the notebook locally with either When you execute the notebook locally with either `tox -- docs/guides/circuit-transpilation-settings.ipynb --test-strategy=hardware --write` or `tox -- docs/guides/circuit-transpilation-settings.ipynb --test-strategy=hardware --write --patch '{patch="qiskit-ibm-runtime"}'`, the script will populate
Copy link
Copy Markdown
Collaborator

@Eric-Arellano Eric-Arellano Mar 17, 2026

Choose a reason for hiding this comment

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

Something got messed up here with the grmmar

this cell with the package versions so users can reproduce the results.

It will also update during the cron jobs.
Copy link
Copy Markdown
Collaborator

@Eric-Arellano Eric-Arellano Mar 17, 2026

Choose a reason for hiding this comment

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

It was ambiguous

Suggested change
It will also update during the cron jobs.
The package versions will also update during the cron jobs.


### Execute notebooks

Before submitting a new notebook or code changes to a notebook, you must run
Expand Down Expand Up @@ -234,7 +236,7 @@ graphviz`.
```sh
tox -- <path/to/notebook.ipynb> <path/to/another-notebook.ipynb>
```
- To write the execution results to the file, pass the `--write` argument.
- To write the execution results to the file, pass the `--write` argument. (Note this generates the package version info cell mentioned in [this section](#add-package-version-information).)
Copy link
Copy Markdown
Collaborator

@Eric-Arellano Eric-Arellano Mar 17, 2026

Choose a reason for hiding this comment

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

I think this might be noisy? Unless you're specifically trying to update the versions, this is kind of noisy and you'd see in the Git diff already that it changed.

If you are trying to update the versions, hopefully you would find the section in the README above about that

Since we only allow writing results from real hardware, you will usually also
need to pass `--test-strategy=hardware`. Note this means the run will use QPU
time.
Expand Down
Loading