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

UCCSD docs should have an example #1137

Open
Cryoris opened this issue Apr 20, 2023 · 7 comments
Open

UCCSD docs should have an example #1137

Cryoris opened this issue Apr 20, 2023 · 7 comments
Assignees
Labels
good first issue Good for newcomers type: documentation Issues related to documentation

Comments

@Cryoris
Copy link
Contributor

Cryoris commented Apr 20, 2023

What should we add?

It may not be quite obvious how to initialize the UCCSD ansatz from the docs only, so it would be nice to add a brief example:
https://qiskit.org/ecosystem/nature/stubs/qiskit_nature.second_q.circuit.library.UCCSD.html#uccsd

@Cryoris Cryoris added type: documentation Issues related to documentation type: feature request New feature or request labels Apr 20, 2023
@mrossinek mrossinek added good first issue Good for newcomers and removed type: feature request New feature or request labels Apr 20, 2023
@woodsp-ibm
Copy link
Member

There is a howto, maybe that can be linked from the API ref. (This is the howto as published presently https://qiskit.org/ecosystem/nature/howtos/vqe_ucc.html)

@CarlosQbit
Copy link

Hello, I am new at contributing. I do not where to start, I am getting familiar with Qiskit, can I be assigned this task?

@mrossinek
Copy link
Member

Sure @CarlosQbit, please go ahead with a PR 👍

You may find the content from the following How-To guide a useful starting point: https://qiskit.org/ecosystem/nature/howtos/vqe_ucc.html

While you are at it, it would be great if we could add examples to all of these related classes:

  • UCC
  • UCCSD
  • SUCCD
  • PUCCD
  • UVCC
  • UVCCSD

In fact, the UCC class has already a few minor examples on some of its more specific configuration options, so reading that might also be a good starting point.

@athanzxyt
Copy link

Hi @Cryoris @mrossinek , would it be possible for I to also be assigned this issue, considering that there hasn't been much activity?

@nasir26
Copy link

nasir26 commented Jun 13, 2023

Hello,
I am new to the Qiskit community. Is this issue still open?

@mrossinek
Copy link
Member

Hi @nasir26

Several people have already voiced interest in working on this. Since I have not seen any PRs, I am tagging them here to get some feedback whether they are still planning to work on this issue: @CarlosQbit @athanzxyt

I suggest you discuss between the three of you who can work on this.

@SamD-1998
Copy link

Hey, this issue seems like just a documentation. I can do it within this week if there are no objections.

@mrossinek mrossinek linked a pull request Sep 6, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers type: documentation Issues related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants