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]: Add Subspace Search Variational Quantum Eigensolver (SSVQE) #515

Closed
JoelHBierman opened this issue Aug 29, 2023 · 11 comments · Fixed by #520
Closed

[Submission]: Add Subspace Search Variational Quantum Eigensolver (SSVQE) #515

JoelHBierman opened this issue Aug 29, 2023 · 11 comments · Fixed by #520
Labels
ready submission Project submission

Comments

@JoelHBierman
Copy link
Contributor

JoelHBierman commented Aug 29, 2023

Github repo

https://github.com/JoelHBierman/SSVQE

Description

The SSVQE algorithm (https://arxiv.org/abs/1810.09434) is a generalization of VQE to find low-lying eigenstates of a Hermitian operator. This specific implementation of SSVQE carries out one optimization procedure using weights.

Email

[email protected]

Alternatives

No response

License

Apache License 2.0

Affiliations

Duke University

Labels

Algorithms, Chemistry

Website

No response

@JoelHBierman JoelHBierman added the submission Project submission label Aug 29, 2023
@mickahell mickahell reopened this Aug 30, 2023
@mickahell
Copy link
Collaborator

Hi @JoelHBierman :)

Can you plain text your description please

@mickahell mickahell reopened this Aug 30, 2023
@frankharkins
Copy link
Member

Also, @JoelHBierman can you try to keep the description ~30 words? For example:

The SSVQE algorithm (https://arxiv.org/abs/1810.09434) is a generalization of VQE to find low-lying eigenstates of a Hermitian operator. This specific implementation of SSVQE carries out one optimization procedure using weights.

This description is just for the qiskit.org/ecosystem web page, where users will work out if the project is what they're looking for. They'll click through to your repo for more details on how it works.

@JoelHBierman
Copy link
Contributor Author

I see, yes I'll shorten the description and move the rest to the README.

@frankharkins frankharkins reopened this Sep 1, 2023
@github-actions github-actions bot added the on hold Waiting for action from third party label Sep 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2023

Standard tests

❌ The submission didn't pass the standard check.
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.

Stable tests

⚠️ The submission didn't pass the stable check.
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.

Development tests

⚠️ The submission didn't pass the development check.
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.


Logs: https://github.com/qiskit-community/ecosystem/actions/runs/6048983539
PR #520

@mickahell
Copy link
Collaborator

Hi @JoelHBierman
Can you add the ecosystem.json file at the root of your repo with something like that :

{
    "dependencies_files": [
        "requirements.txt",
        "requirements-dev.txt"
    ],
    "extra_dependencies": [
        "pytest"
    ],
    "language": {
        "name": "python",
        "versions": ["3.9"]
    },
    "tests_command": [
        "pytest"
    ],
    "styles_check_command": [
        "pylint -rn ssvqe test"
    ],
    "coverages_check_command": [
        "coverage3 run -m pytest",
        "coverage3 report --fail-under=80"
    ]
}

@JoelHBierman
Copy link
Contributor Author

Yes I'll work on that and add it shortly.

@JoelHBierman
Copy link
Contributor Author

I have added this file along with the other files from the ecosystem template that were missing.

@JoelHBierman
Copy link
Contributor Author

JoelHBierman commented Sep 1, 2023

Can some of the settings in .pylintrc be customized or are these strict standards that all packages in the community repo must adhere to? Using the defaults, I do not think this package would pass the linting tests without some extensive re-writing with regards to the number of class attributes, variables, ect...

@mickahell mickahell reopened this Sep 1, 2023
@mickahell
Copy link
Collaborator

Can some of the settings in .pylintrc be customized or are these strict standards that all packages in the community repo must adhere to? Using the defaults, I do not think this package would pass the linting tests without some extensive re-writing with regards to the number of class attributes, variables, ect...

We do not check the lint anymore, maybe one day we will but today we are not :)

@github-actions github-actions bot added ready and removed on hold Waiting for action from third party labels Sep 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2023

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/6053496593
PR #520

frankharkins added a commit that referenced this issue Sep 4, 2023
Add SSVQE to list.

---
Closes #515

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

1ucian0 commented Sep 6, 2023

hello @JoelHBierman! 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.

4 participants