Skip to content
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

Deprecated code in "Getting Started" in README #325

Closed
nemill opened this issue Jun 6, 2023 · 3 comments
Closed

Deprecated code in "Getting Started" in README #325

nemill opened this issue Jun 6, 2023 · 3 comments
Assignees
Labels
bug A bug or regression

Comments

@nemill
Copy link

nemill commented Jun 6, 2023

Describe the bug
In the "Getting Started" section of the README.md file, both examples contain:
from pygsti.construction import std1Q_XYI

pygsti.construction appears to be deprecated, possibly replaced by pygsti.modelpacks

To Reproduce
Running the line above produces:
ModuleNotFoundError Traceback (most recent call last)
Cell In[8], line 1
----> 1 from pygsti.construction import std1Q_XYI

ModuleNotFoundError: No module named 'pygsti.construction'

Expected behavior
The Getting Started section promises some quick examples of circuit simulation and gate set tomography, both of which are dependent on this deprecated package. It would be helpful to update this "Getting Started" section with the most current packages/syntax, possibly pointing to the tutorials.

Environment (please complete the following information):

  • pyGSTi version 0.9.11.1
  • python version 3.10.9
  • OS - Windows 11
@nemill nemill added the bug A bug or regression label Jun 6, 2023
@coreyostrove coreyostrove self-assigned this Jun 6, 2023
@coreyostrove
Copy link
Contributor

Thanks for bringing this to our attention, @nemill! It is funny how easy it is to miss the things that are just in front of us. This runs adjacent to but was missed in issue #317 where I described the goal for an upcoming release to bring the tutorial notebooks back up to date (just for context). Please do raise additional issues if you run into any other places where we have out of date code outside of the readme and the tutorials.

@sserita
Copy link
Contributor

sserita commented Aug 11, 2023

This is now fixed in bugfix-example-updates as of commit 79a16ad. That branch will likely stay open for things in issue #317 for now, though.

@sserita sserita added the fixed-but-not-in-release-yet Bug has been fixed, but isn't in an official release yet (just exists on a development branch) label Aug 11, 2023
sserita added a commit that referenced this issue Nov 28, 2023
Should fix issue #325 for release 0.9.12
@sserita
Copy link
Contributor

sserita commented Nov 29, 2023

Closed with release of 0.9.12.

@sserita sserita closed this as completed Nov 29, 2023
@sserita sserita removed the fixed-but-not-in-release-yet Bug has been fixed, but isn't in an official release yet (just exists on a development branch) label Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A bug or regression
Projects
None yet
Development

No branches or pull requests

3 participants