qiskit-community / qiskit-nature

Qiskit Nature is an open-source, quantum computing, framework for solving quantum mechanical natural science problems.
https://qiskit-community.github.io/qiskit-nature/
Apache License 2.0
300 stars 202 forks source link

UCCSD docs should have an example #1137

Open Cryoris opened 1 year ago

Cryoris commented 1 year ago

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

woodsp-ibm commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

Sure @CarlosQbit, please go ahead with a PR :+1:

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:

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 commented 1 year ago

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

nasir26 commented 1 year ago

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

mrossinek commented 1 year ago

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 commented 1 year ago

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