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

Add qutip-qip tutorials to documentation on Read the docs #204

Closed
nathanshammah opened this issue May 25, 2023 · 7 comments
Closed

Add qutip-qip tutorials to documentation on Read the docs #204

nathanshammah opened this issue May 25, 2023 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@nathanshammah
Copy link
Member

Issue description

Add links for exisiting qutip-qip notebooks on the read the docs documentation at https://qutip-qip.readthedocs.io/en/stable/, similarly to what is done for Mitiq. Right now there is a tutorials section (see screenshot below)

qutipqip-doc

but it only contains a link to qutip.org, as the tutorials appear only on the https://qutip.org/qutip-tutorials/ under the QIP section, see screenshot below.

qutip-qip

Proposed Solution

The tricky part is that we don't want to duplicate the files, the source files should remain from qutip-tutorials, such as for the
"Decomposition of the Toffoli gate in terms of CNOT and single-qubit rotations" that is rendered from

https://nbviewer.org/urls/qutip.org/qutip-tutorials/tutorials-v4/quantum-circuits/qip-toffoli-cnot.ipynb

The tutorials should be kept also on the https://qutip.org/qutip-tutorials/#quantum-information-processing as they currently exist.

References

@nathanshammah nathanshammah added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels May 25, 2023
birajkarki added a commit to birajkarki/qutip-qip that referenced this issue May 26, 2023
@Algh89110377
Copy link

Hi, It is my first time contributing to open-source problems. I like to tackle this one. Will you please add me?

@natestemen
Copy link

Hackers! This bounty has increased in value! What was worth $50 is now $100!

@miaortizma
Copy link

Hi, would git submodules be an acceptable solution?

@BoxiLi
Copy link
Member

BoxiLi commented Jun 15, 2023

@rum1887 Could you comment here so that I can assign you?

@rum1887
Copy link
Contributor

rum1887 commented Jun 15, 2023

Hi, here's the pr for this issue #207

@BoxiLi
Copy link
Member

BoxiLi commented Jun 16, 2023

@nathanshammah @natestemen This has been solved! Thank you @rum1887

@BoxiLi BoxiLi closed this as completed Jun 16, 2023
@nathanshammah
Copy link
Member Author

Congratulations @rum1887!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

6 participants