Add high-level function for SQD

[kevinsung]

Fixes #191
Fixes #192
Fixes #182
Fixes #113
Fixes #189 (remaining work tracked at #204 and #205)

[caleb-johnson]

Thanks @kevinsung , if we want to resolve #189 I think we'd want to go through all the notebooks where we run this loop (e.g. orbital optimization how-to, ...) and take the min occupancies there too, right?

[kevinsung]

Thanks @kevinsung , if we want to resolve #189 I think we'd want to go through all the notebooks where we run this loop (e.g. orbital optimization how-to, ...) and take the min occupancies there too, right?

Ok sure, we can do that separately. I no longer marked this PR as closing that issue.

[kevinsung]

@caleb-johnson I've updated the two tutorials, but I'd like you to review the code and make sure you're okay with it before I update the rest of the documentation to use this high-level function.

[jrm874]

The new additions look good to me!

I have added a couple of comments regarding some variable/function names

[caleb-johnson]

Thanks Kevin, this is looking good! I left a few comments and will continue to review

[kevinsung]

Updating https://github.com/Qiskit/qiskit-addon-sqd/blob/main/docs/how_tos/use_oo_to_optimize_hamiltonian_basis.ipynb is blocked by #202

[caleb-johnson]

Looks really great, nice work. Thanks! 🚀

Just a couple of very minor suggestions/comments

[caleb-johnson]

Tutorials:

• We could just link out to the API docs for your new high level function and lean up the arg descriptions on both tutorials quite a bit
• "Note: Qiskit Aer is required to simulate samples from transpiled circuits."
  • You're using Runtime here, I think we can delete this old comment now
• Regardless of how you feel about bullet 1, I think tutorial 2 needs some arg descriptions for the high level function, even if you just link back to tutorial 1 (or API docs)

[kevinsung]

We could just link out to the API docs for your new high level function and lean up the arg descriptions on both tutorials quite a bit

Done.

"Note: Qiskit Aer is required to simulate samples from transpiled circuits."
You're using Runtime here, I think we can delete this old comment now

Actually, Qiskit Aer is still required. If it's not installed, the following error is raised:

BasicProviderError: 'Number of qubits 127 is greater than maximum (24) for "basic_simulator".'

Regardless of how you feel about bullet 1, I think tutorial 2 needs some arg descriptions for the high level function, even if you just link back to tutorial 1 (or API docs)

I just did the same thing I did for Tutorial 1 and linked to the API docs.

[caleb-johnson]

Looks great, thanks!! 🚀