Submit a Demo
The PennyLane Team warmly invites you, researchers building the future of quantum, to submit your own coding demos that showcase your research, inspire others, and accelerate progress in the quantum community. Whether you are using PennyLane or another tool, by contributing a demo you will not only feature your work on the PennyLane website and highlight your innovations to fellow researchers, but also open the door to collaborations on a global scale.
How to submit a demo
To contribute a demo that will be featured as a PennyLane Demo, authors (in most cases) write a standalone code-based demonstration that executes on the PennyLane website. Demos often showcase the results of recent research papers or significant topics and techniques important for the research community. Readers can download demos as a Jupyter Notebook or a Python script, leave comments, ask questions on the Discussion Forum, and even suggest improvements or provide feedback directly on GitHub.
Each PennyLane Demo goes through a review process, where our team supports you to create a technically sound, clear and interesting presentation of your research, with code, explanations and conclusions that help your colleagues and potential collaborators pick up the topic, run the algorithms, and interact with your work at the click of a button and as successfully as possible.
Once you're ready to create a demo, you can write it up as a simple Jupyter Notebook and use the step-by-step instructions in the
Demo repository to convert it into a .py
file, add some additional information about yourself and your work, and finally
submit a pull request in which you can tag our team for review.
Demo guidelines
General instructions for PennyLane Demos can be found in the README
file of
the Demo repository, but if you have
questions about anything that isn't mentioned in the instructions, please don't
hesitate to reach out via the public Xanadu Slack workspace
or the PennyLane Discussion Forum,
and our team will be sure to help out.
We strongly recommend that you get in touch with our team via the contact form on the Get involved page, so we can help guide you through the process, share early feedback as you plan your demo, and support you in presenting your work in the best possible way. Depending on the topic and application of your demo, there may also be an opportunity to collaborate with the PennyLane Team and take your research a step further.
An alternative approach: Submit a Community Demo
If you would like to highlight your research to the quantum community, but don't have time to contribute a full-scale demo, we also maintain a collection of Community Demos, where researchers can share links to the code repositories and resources that demonstrate their research. Be it a recently published paper or your master's thesis, other researchers will be able to easily find your work, get in touch with you, and continue innovating in quantum computing.
To submit a Community Demo, simply create a new issue in the PennyLane Demo
GitHub repository, follow the demo-submission template,
complete the full title, add links to your publication and code repository,
contact information for yourself and your collaborators, and submit! We
recommend that you create a user-friendly Jupyter Notebook or clear README
instructions in your repository to make the project easy to understand, but you
can include all scripts and formats that you wish. Alternatively, you could link
directly to a code notebook on services such as
Colab,
nbviewer,
Sagemaker, or
Binder. For other ideas, please take a look at some of our
recent Community Demos.
Once you've submitted the issue in our GitHub repository, our team will take a look to make sure everything works and get back to you with helpful feedback. Within a few days, we will publish and promote your submission, and you will have made another strong contribution to the growth of the quantum computing research community!
Community Demo guidelines
While you are free to be as creative as you'd like with your Community Demo repository or linked notebook, there are a couple of guidelines that might be good to keep in mind.
-
The title of the Community Demo should be clear and concise; if it is based on a publication, it should be very similar to the title of the publication.
-
Please include a reference or link to your work, as well as yours and your collaborators' names (and, optionally, contact information).
-
Include a short summary or abstract below the title — just a few sentences that clearly state the goal and outcome of your work, as well as links or refences to materials you've used.
-
If you are including several files, we recommend that you explain the purpose of each of them in the
README
file. -
Please include comments and explanations in your code. The goal is that your reader can independently use and understand your work, so please help them out.
-
If your content contains random variables or outputs, a fixed seed should be set for reproducibility.
-
Include all dependencies (e.g., the exact version of PennyLane along with the versions of any PennyLane plugins you've used). If possible, include a
requirements.txt
file with your local output after runningpip freeze
. -
All content should be original or free to reuse subject to license compatibility. For example, if you are implementing someone else's research, reach out to receive permission to reproduce exact figures before submitting. Otherwise, avoid direct screenshots from papers, and instead refer to figures in the paper within the text.
If you're not sure what kind of demo fits you best, if you have any questions, ideas, or want to tell us something before you start, feel free to visit the public Xanadu Slack workspace to contact us, or reach out via the form on the Get involved page.