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

[Submission]: Quantum Glasses #478

Closed
Jayshah25 opened this issue Aug 3, 2023 · 18 comments · Fixed by #479
Closed

[Submission]: Quantum Glasses #478

Jayshah25 opened this issue Aug 3, 2023 · 18 comments · Fixed by #479
Labels
ready submission Project submission

Comments

@Jayshah25
Copy link

Jayshah25 commented Aug 3, 2023

Github repo

https://github.com/Jayshah25/Quantum-Glasses

Description

Visualise the effects of Single Qubit Gates on a Qubit via Bloch Sphere Simulation in a Tkinter Software.

Email

[email protected]

Alternatives

The only alternative is to code up a circuit (qiskit.QuantumCircuit) and pass the circuit to visualize_transition from qiskit.visualization. Quantum Glasses implementation wraps all of this into a simple, easy to use Tkinter Software.

License

Apache License 2.0

Affiliations

No response

Tags

visualization

Website

No response

@Jayshah25
Copy link
Author

Jayshah25 commented Aug 3, 2023

The tag for this project could be "visualization" or "widget".

@Jayshah25 Jayshah25 mentioned this issue Aug 3, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 3, 2023

Submission PR #479 has been created with errors in tests ⚠️
See logs: https://github.com/qiskit-community/ecosystem/actions/runs/5754273126
Please follow minimal requirements for project or/and add ecosystem.json configuration in the root of the project
Read more here https://github.com/qiskit-community/ecosystem/blob/main/docs/project_overview.md#adding-project-to-the-ecosystem

@github-actions
Copy link
Contributor

github-actions bot commented Aug 3, 2023

Tests with latest version of Qiskit release failed! ⚠️
This means your project doesn't work with the latest version of Qiskit.
This is purely informational and doesn't affect your project joining the Ecosystem, but you may want to investigate the problem.
See logs: https://github.com/qiskit-community/ecosystem/actions/runs/5754273126

@github-actions
Copy link
Contributor

github-actions bot commented Aug 3, 2023

Tests with development version of Qiskit release failed! ⚠️
This means your project might not work with the next version of Qiskit.
This is purely informational and doesn't affect your project joining Ecosystem.
See logs: https://github.com/qiskit-community/ecosystem/actions/runs/5754273126

@mickahell
Copy link
Collaborator

mickahell commented Aug 3, 2023

The problem seems to be your requirements, you don't need most of them.

From your program file, you only need :

  • qiskit
  • qiskit[visualization]
  • numpy
  • tkinter
  • pytest (only for tests)

Your test is not a test class, here an example of a simple test : https://github.com/mickahell/qiskit-ecosystem_template/blob/main/tests/test_random.py

@mickahell mickahell added submission Project submission on hold Waiting for action from third party labels Aug 3, 2023
@Jayshah25
Copy link
Author

Jayshah25 commented Aug 4, 2023

Most of the other packages are dependencies of qiskit.
I have updated the tests with test class

@mickahell
Copy link
Collaborator

Most of the other packages are dependencies of qiskit. I have updated the tests with test class

Pip know how to deal with dependencies, just add the strict minimum.

@Jayshah25
Copy link
Author

Jayshah25 commented Aug 4, 2023

contourpy==1.1.0 # matplotlib dependency, not required for project
cycler==0.11.0
dill==0.3.7
exceptiongroup==1.1.2 # for pytest
fonttools==4.42.0 # matplotlib dependency, not required for project
iniconfig==2.0.0 # for pytest
kiwisolver==1.4.4
matplotlib==3.7.2
mpmath==1.3.0
numpy==1.25.2
packaging==23.1
Pillow==10.0.0
pluggy==1.2.0 # for pytest
ply==3.11
psutil==5.9.5
pyparsing==3.0.9
pytest==7.4.0
python-dateutil==2.8.2
qiskit==0.44.0
qiskit-terra==0.25.0
rustworkx==0.13.1
six==1.16.0
stevedore==5.1.0
sympy==1.12
typing_extensions==4.7.1

I have tried to remove everything unnecessary. The three modules "exceptiongroup", "iniconfig" and "pluggy" are only required for pytest. The other two modules "contourpy" and "fonttools" are not required for the project but are dependencies of the matplotlib.

All the other modules that seem insignificant are required for a successful run. I have manually checked it.

@mickahell
Copy link
Collaborator

You can do even better ;)

What you don't need :

  • qiskit-terra part of qiskit package
  • python-dateutil part of python
  • rustworkx part of qiskit
  • ...

More generally, if you don't need to import it in your program you don't need to install it.
image
So in your program you are using, qiskit, qiskit[visualization], numpy, tkinter and pytest.

During the pip setup of those packages, pip will handle by himself the dependencies they need and their version. You can trust him :) (else your program could not be able to works correctly on different OS and python env).

If you want to check what I'm saying you can setup automatic testing with github Actions and using tox (look at this repo : qiskit-ecosystem_template )

@Jayshah25
Copy link
Author

Jayshah25 commented Aug 4, 2023

All those packages rustworkx, cycler etc are required for the visualize_transition function.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

Submission PR #479 has been created with errors in tests ⚠️
See logs: https://github.com/qiskit-community/ecosystem/actions/runs/5763670818
Please follow minimal requirements for project or/and add ecosystem.json configuration in the root of the project
Read more here https://github.com/qiskit-community/ecosystem/blob/main/docs/project_overview.md#adding-project-to-the-ecosystem

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

Tests with latest version of Qiskit release failed! ⚠️
This means your project doesn't work with the latest version of Qiskit.
This is purely informational and doesn't affect your project joining the Ecosystem, but you may want to investigate the problem.
See logs: https://github.com/qiskit-community/ecosystem/actions/runs/5763670818

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

Tests with development version of Qiskit release failed! ⚠️
This means your project might not work with the next version of Qiskit.
This is purely informational and doesn't affect your project joining Ecosystem.
See logs: https://github.com/qiskit-community/ecosystem/actions/runs/5763670818

@Jayshah25
Copy link
Author

So, I need to add ecosystem.json to the project, right?

@mickahell
Copy link
Collaborator

@Jayshah25 I created you a PR with everything you need Jayshah25/Quantum-Glasses#1

@Jayshah25
Copy link
Author

Thank you for the PR. I have merged it with the main branch.

@mickahell mickahell reopened this Aug 19, 2023
@github-actions github-actions bot added ready and removed on hold Waiting for action from third party labels Aug 19, 2023
@github-actions
Copy link
Contributor

Standard tests

✨ Successfull submission!

Stable tests

✨ Tests with latest version of Qiskit release passed!

Development tests

✨ Tests with development version of Qiskit release passed!


Logs: https://github.com/qiskit-community/ecosystem/actions/runs/5911224903
PR #479

Eric-Arellano pushed a commit that referenced this issue Aug 19, 2023
Add Quantum-Glasses to list.

---
Closes #478

Co-authored-by: mickahell <[email protected]>
@1ucian0
Copy link
Member

1ucian0 commented Sep 6, 2023

Hello @Jayshah25! You joined the Qiskit Ecosystem a little while ago and I just wanted to check in and let you know of some follow up actions you can take to make the most of joining the program, if you're interested:

💬 Join other Qiskit ecosystem developers in the Slack channel #qiskit-ecosystem (if you are not in the Qiskit workspace yet, you can sign up here: https://qisk.it/join-slack)

🧠 Help us define the future of the Qiskit Ecosystem: we recently started an RFC on how the Ecosystem should be structured. It is very draft-y at the moment, but you can subscribe for notifications here Qiskit/RFCs#46 to participate in that discussion.

📣 Would you like to showcase your project to the Qiskit community? A couple of things you can do to raise awareness for your project:

Great having you as a part of the ecosystem!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready submission Project submission
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants