Write, autoreview, editor, reviewer
3,129
edits
Submissions: Difference between revisions
Jump to navigation
Jump to search
→Format
(→Format) |
|||
| Line 11: | Line 11: | ||
https://forms.gle/ANokaD4iCzwvYjdb6 | https://forms.gle/ANokaD4iCzwvYjdb6 | ||
== | ==Guidelines== | ||
Following are the section-wise guidelines for both types of files available on the zoo. Contributors may consider an example from the [[Protocol Library]] too, if needed. | |||
=== Functionality File=== | === Functionality File=== | ||
Functionality file describes a general task which can be realized in a quantum network (the "what"). It consists of the following sections. | Functionality file describes a general task which can be realized in a quantum network (the "what"). It consists of the following sections. | ||
| Line 26: | Line 26: | ||
Protocol file describes a specific protocol implementing the defined functionality (the "how"). It consists of the following sections. | Protocol file describes a specific protocol implementing the defined functionality (the "how"). It consists of the following sections. | ||
</br> | </br> | ||
*'''Introductory paragraph''' | *'''Introductory paragraph''' gives a link to the functionality page, article on the example protocol and justify how the | ||
*'''Tags''' | protocol is different from other protocol drafts for the concerned functionality. | ||
*'''Assumptions''' | **No new terms should be used unless explained in the same paragraph. If the term is complex | ||
*'''Outline''' | and needs further explanation one can also provide a link for the same to the supplementary | ||
*''' | information page. e.g. �fidelity (measure of how close two quantum states are), and the link | ||
*'''Requirements''' | would direct one to a mathematical formulae of the same in the supplementary page. | ||
*'''Properties''' | **No �fictional names to be used. The parties should be called according to their roles. E.g. Client- | ||
*''' | Server instead of Alice-Bob is preferred. | ||
*'''Further Information''' | **Avoid mathematical equations or notations. | ||
**Try to provide a real life use case for the protocol example signing documents etc.. | |||
*'''Tags''' are terms used to link several pages on the zoo similar or useful in certain aspect for the concerned file. Categories to which the files belong can also be mentioned here. | |||
** Available [[:Category:Categories|categories]] for the zoo files can be found in the Navigation menu. | |||
*'''Assumptions''' describe the scenerio in which the protocol will be successful and hence, it is necessary to be mentioned before one starts discussing the protocol. | |||
**List all the assumptions taken on the hardware setup or adversary in the given protocol. | |||
*'''Outline''' is a comprehensive wordy description. Guidelines should be strictly followed for this section. | |||
** No mathematical notations or equations should be used. | |||
**Bullet points are preferred. | |||
**It should be lucid, and one is free to make this section lengthy (yet avoid redundancy) such that it gives a rough picture of the protocol without any specifi�c details like number of qubits used or threshold value if any. | |||
*'''Notations''' The following sections on properties and pseudo code contain mathematical equations and hence | |||
to connect it with the wordy outline this section displays all notations used. | |||
*'''Requirements''' Mentions implementation details like benchmark values, network stage, required parameters and accommodates a figure on the decomposition of the protocol into various components required for implementation. | |||
*'''Properties''' This section is a list of all important details which were not given in the | |||
wordy outline. One could list all that one thinks is important for the reader to know | |||
and can be extracted from the protocol. e.g: | |||
# List of parameters used e.g. threshold value etc. | |||
# Security Claims and other theorems used for the protocol e.g. correctness, veri�fiability, blindness, universality | |||
# Advantages in terms of resources. e.g. no quantum memory needed etc. | |||
# Success probability of protocols (for entanglement routing and other building blocks protocols). | |||
# Mathematical equations or inequalities for security claims and other items mentioned above can | |||
be accommodated here. | |||
#If using new term for any of the above, please explain it here itself and if needed, provide a link to | |||
supplementary information page for a detailed explanation. E.g. Any property not defi�ned in the | |||
functionality description already could be defi�ned here. | |||
*'''Pseudo Code'''This section contains an algorithm/ pseudo code of the protocol. | |||
**Should be step-wise description of the protocol with mathematical equations. Avoid words as much as possible. | |||
** Can be divided into stages common for all the protocols in the concerned functionality. For example, Delegated Computing | |||
can be divided into Preparation and Computation Stage. | |||
** Every stage (there can be only one stage in a protocol too) should have Inputs and Outputs for each party. | |||
*'''Further Information''' This is a review section on all the similar protocol in terms of method used. It can be skipped and different contributors can choose to write this section for various files uploaded on the zoo. | |||