qir-alliance / pyqir

PyQIR is a set of APIs for generating, parsing, and evaluating Quantum Intermediate Representation (QIR).
https://qir-alliance.github.io/pyqir
MIT License
58 stars 24 forks source link

Update generator readme for new API #64

Closed bamarsha closed 2 years ago

bamarsha commented 2 years ago

Closes #61.

idavis commented 2 years ago

@samarsha I think we also need to update uninstalling-the-packages and troubleshooting

bamarsha commented 2 years ago

@samarsha I think we also need to update uninstalling-the-packages and troubleshooting

@idavis I updated the module names in the troubleshooting section. What did you want to update in "uninstalling the packages?" I thought the package names haven't changed.

idavis commented 2 years ago

@samarsha - good point, sorry, does this change still make sense then?

- `ModuleNotFoundError: No module named '(pyqir|pyqir.generator|pyqir.parser|pyqir.jit)'`:
  Install the library by running one of the `install.(sh|ps1|cmd)` scripts.
bamarsha commented 2 years ago

The ModuleNotFoundError does have a dot in it.

If you try import pyqir.generator without any PyQIR packages installed, you get "ModuleNotFoundError: No module named 'pyqir'". If you try import pyqir.generator with at least one PyQIR package installed (but not generator), you get "ModuleNotFoundError: No module named 'pyqir.generator'"