Write, autoreview, editor, reviewer
3,125
edits
Submissions: Difference between revisions
Jump to navigation
Jump to search
m
no edit summary
mNo edit summary |
|||
| Line 4: | Line 4: | ||
Each of the files has a predefined format, see below. To keep the wiki consistent, we kindly ask you to follow the guidelines on the format. | Each of the files has a predefined format, see below. To keep the wiki consistent, we kindly ask you to follow the guidelines on the format. | ||
Currently, submissions can be made via Google forms, see link below. In the Google form you should specify which file (functionality or protocol file) you would like to submit. Currently, we accept submissions in plain text (.txt file), supplemented with .png, .jpg or .pdf for figures. Note that Quantum Protocol Zoo accepts only published work. Submissions will be considered by the Quantum Protocol Zoo team and the final decision on acceptance resides with the team. | Currently, submissions can be made via Google forms, see link below. In the Google form, you should specify which file (functionality or protocol file) you would like to submit. Currently, we accept submissions in plain text (.txt file), supplemented with .png, .jpg or .pdf for figures. Note that Quantum Protocol Zoo accepts only published work. Submissions will be considered by the Quantum Protocol Zoo team and the final decision on acceptance resides with the team. | ||
What is more, you can submit a request for an article in the Discussion section on this page. Such a request will be considered and, if accepted, added by to the wiki by the team. You are welcome to express your general comments in the Discussion to make the wiki more user-friendly. | What is more, you can submit a request for an article in the Discussion section on this page. Such a request will be considered and, if accepted, added by to the wiki by the team. You are welcome to express your general comments in the Discussion to make the wiki more user-friendly. | ||
| Line 12: | Line 12: | ||
==Guidelines== | ==Guidelines== | ||
Protocol file describes a specific protocol implementing the defined functionality (the "how"). Following are the section-wise guidelines for protocol files for submission. Contributors may consider an example from the [[Protocol Library]] too | Protocol file describes a specific protocol implementing the defined functionality (the "how"). Following are the section-wise guidelines for protocol files for submission. Contributors may consider an example from the [[Protocol Library]] too if needed. | ||
</br> | </br> | ||
*'''Introductory paragraph''' gives a link to the functionality page, article on the example protocol and justify how the | *'''Introductory paragraph''' gives a link to the functionality page, article on the example protocol and justify how the | ||
protocol is different from other protocol drafts for the concerned functionality. | protocol is different from other protocol drafts for the concerned functionality. | ||
**No new terms should be used unless explained in the same paragraph. If the term is complex 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 would direct one to a mathematical | **No new terms should be used unless explained in the same paragraph. If the term is complex and needs further explanation one can also provide a link for the same to the supplementary information page. e.g. fidelity (a measure of how close two quantum states are), and the link would direct one to a mathematical formula of the same in the supplementary page. | ||
**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. | **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. | ||
**Avoid mathematical equations or notations. | **Avoid mathematical equations or notations. | ||
**Try to provide a real life use case for the protocol example signing documents etc.. | **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. | *'''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. | ** Available [[:Category:Categories|categories]] for the zoo files can be found in the Navigation menu. | ||
*'''Assumptions''' describe the | *'''Assumptions''' describe the scenario 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. | **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. | *'''Outline''' is a comprehensive wordy description. Guidelines should be strictly followed for this section. | ||
** No mathematical notations or equations should be used. | ** No mathematical notations or equations should be used. | ||
**Bullet points are preferred. | **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 specific details like number of qubits used or threshold value if any. | **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 specific details like the 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. | *'''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. | *'''Component 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 including the physical resources, nodal subroutines, and other protocols used. | ||
*'''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: | *'''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. | # List of parameters used e.g. threshold value etc. | ||
| Line 37: | Line 37: | ||
# Mathematical equations or inequalities for security claims and other items mentioned above can | # Mathematical equations or inequalities for security claims and other items mentioned above can | ||
be accommodated here. | 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 defined in the functionality description already could be defined here. | #If using a new term for any of the above, please explain it here itself and if needed, provide a link to the supplementary information page for a detailed explanation. E.g. Any property not defined in the functionality description already could be defined here. | ||
*'''Pseudo Code'''This section contains an algorithm/ pseudo code of the protocol. | *'''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. | **Should be a 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 stages common for all the protocols in the concerned functionality. For example, Delegated Computing | ||
can be divided into Preparation and Computation Stage. | 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. | ** 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. | *'''Further Information''' This is a review section on all the similar protocol in terms of the method used. It can be skipped and different contributors can choose to write this section for various files uploaded on the zoo. | ||