IPOL wiki/ ref/ Software Guidelines
  • Accepted programming languages are C, C++, Python and Octave/Matlab.
  • Only the source codes needed to implement the pseudocodes described in the manuscript must be furnished.
  • The code must be clear and commented, and it must match the pseudocodes.
  • The main functions of the source code must be 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”).
  • Provide some test data to check the code.
  • All the source code files must 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/>.

  • The following warning (or similar) must be 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.

  • Include 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.