PyCVXQuad 10/21

[simsaidan]

Description

Provide a brief description of the PR's purpose here. If your PR is supposed to fix an existing issue, use
a keyword to link your PR to the issue.

Changes

Notable changes that this PR has either accomplished or will accomplish. Feel free to add more lines to the itemized list
below.

• Change 1

Checklist

Before marking your PR ready for review, make sure you checked the following locally. If this is your first PR, you might be notified of some workflow failures after a maintainer has approved the workflow jobs to be run on your PR.

Additional information is available in the documentation.

• Use ruff for errors related to code style and formatting.
• Verify all previous and newly added unit tests pass in pytest.
• Check the documentation build does not lead to any failures. Sphinx build can be checked locally for any failures related to your PR
• Use linkcheck to check for broken links in the documentation
• Use doctest to verify the examples in the function docstrings work as expected.

[vprusso]

@simsaidan just FYI, I fixed the one merge conflict that was preventing the subsequent pipelines from running. We should now expect to see some linting failures, but these should be easy enough to resolve. Of course, don't hesitate to reach out if you'd like to ask any questions or if you want to triage some of these together. Let me know what makes sense for you!

[purva-thakre]

Hi @simsaidan, the docstring template in toqito's contributing guide is not up to date. I noticed it during your mid-point check-in presentation. My apologies!

I am linking an example function for what it is supposed to look like:

toqito/toqito/channel_props/is_unital.py

Lines 58 to 62 in 3b91eb6

	:param phi: The channel provided as either a Choi matrix or a list of Kraus operators.
	:param rtol: The relative tolerance parameter (default 1e-05).
	:param atol: The absolute tolerance parameter (default 1e-08).
	:param dim: A scalar, vector or matrix containing the input and output dimensions of PHI.
	:return: :code:`True` if the channel is unital, and :code:`False` otherwise.

You have to use :param name_of_parameter: Description of parameter for it to show up formatted correctly in the RTD build. We can make an issue for correcting the docstrings of the functions already in this PR. Just thought you should know for the remaining functions.

If you want to take a look at how the docstrings are formatted in the docs build, make sure you add your cvx_quad module to docs/autoapi_members.rst.

Edit: The docstring template should be corrected now.

[cosenal]

Hi @simsaidan, Can you please make title and summary of the PR more descriptive? It helps potential reviewers that are not familiar with your project.

Also my advice would be to first make a smaller PR with a single quantity (+test and auxiliary functions, if needed) where we can agree on things like styles, module organization, test approach, dependencies.