IPOL wiki/ ref/ Editors Checklist

As decided in the December 2018 meeting:

There will be systematically two editors per submission. One reads the paper and tests the demo. The other one checks the code.

The following are indications for both editors.

Editor 1 (text and demo):

  • Review the text as with any regular journal paper.
  • Check that the demo "works" for all the provided examples and for variations of the default parameters.
  • A "working demo" must run without errors and its results must be coherent with the description in the text.
  • The execution time of the demo must not exceed 30 seconds. Exceptionally, for demos working with video sequences, an execution time of 1 minute might be allowed. If the computation time is excessive the authors must limit the size of the allowed inputs and add a warning to the demo.

Editor 2 (pseudocode and code):

  • Review the pseudocodes in the text and confirm that the descriptions and notations in the text agree with the pseudocodes.
  • Check that the submitted code includes a README.txt file containing:
    • Title of Paper, with link to IPOL website
    • Version number and date
    • Author name and contact email
    • A description of the contents and organization of the provided files (sources folder, test data folder, etc.)
    • If the source code is split into several files, information about where each pseudocode is implemented (e.g. "Algorithm 1 is implemented in file name.extension")
    • Compilation instructions (if needed)
    • Examples of use
    • Copyright and license information
  • Check that all the source code files contain copyright and license information at the beginning of the file. The typical text is as follows:

Copyright (c) YEAR Author(s)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

  • Check that the following warning (or similar) is inserted after the copyright attribution for all codes potentially linked to a patent:

This file implements an algorithm possibly linked to the patent <REFERENCE OF THE PATENT>. This file is made available for the exclusive aim of serving as scientific tool to verify the soundness and completeness of the algorithm description. Compilation, execution and redistribution of this file may violate patents rights in certain countries. The situation being different for every country and changing over time, it is your responsibility to determine which patent rights restrictions apply to you before you compile, use, modify, or redistribute this file. A patent lawyer is qualified to make this determination. If and only if they don't conflict with any patent terms, you can benefit from the following license terms attached to this file.

  • Check that the main functions of the source code are preceded by a short comment indicating which pseudocode, or portion of the pseudocode, they implement (e.g. "This functions implements lines 10 to 40 of Algorithm 2"), and confirm that pseudocode and code indeed match.
  • Check that only the source codes needed to implement the published pseudocodes are furnished. Exhort the authors to remove all unnecessary files or functions.
  • Check that some test data are provided to check the code.
  • Compile and check that the code works as expected with the provided test data.