Downloadable versions: HTML TXT PDF
Previous versions: archives


IPOL Software Guidelines, version 1.04

IPOL reviews, uses, publishes and distributes some software provided by the authors. With the requirements and recommendations expressed in these guidelines, we intend to facilitate the production and review of verifiable and usable software for reproducible research.

In Brief: Check List, Check Service and Examples

The list hereafter is a summary of the guidelines, to quickly check a program. Some are requirements, others are only recommendations. This document details and explains the guidelines later.

  • zip or tar/gzip archive name_version.{zip,tar.gz,tgz}
  • everything into a name_version/ folder
  • file names with a-z,A-Z,0-9,-,_,.
  • no hidden file, backup or useless file, no binary
  • portable code, 32/64-bits, nothing specific to an operating system
  • command-line non-interactive interface
  • approx. 30 s computation in the demo environment
  • copyright attribution and GPL/BSD license info in every source file
  • patent warning if needed
  • README.txt essential information
  • correct, clean code in English
  • main(), algorithmic and auxiliary code in different files
  • detailed comments for every function and every implementation step
  • example input data and result

About this Document

Status

This document is the official IPOL Software Guidelines, version 1.04, published on May 14th, 2018. It is immediately applicable and obsoletes previous versions. The reference version is available at https://tools.ipol.im/wiki/ref/software_guidelines/.

Revisions

When needed, future versions of this document will be published and will replace the current version. The current version will still be available, with a summary of the differences. This revision will be announced on the IPOL website and the IPOL discussion list.

Changes from version 1.02:

  • Removed restrictions regarding exclusive use of C code.
  • Changed limitations on the size of uploaded files.

Vocabulary

These guidelines are designed for a research journal whose articles include some software material. They are written for IPOL, but may be used by others.

In this document, the term "published software" designates the reference software implementation of an algorithm submitted for publication in a journal article. The "web demo" is an online facility used to test this software. An article may contain more than one software, and a demo may use more than one software.

In this document, the words must, must not, should, should not, recommended, and may are used to express required, recommended, and optional items. IETF RFC2119 describes their interpretation, and Annex A adds details in the context of these guidelines.

License

This document is licensed under a CC-BY License. It can be freely reused and modified as long as its origin is credited. Modified versions must be mentioned as such and not misrepresented as the original IPOL version.

Guidelines

1. Packaging and Content

1.1. Compressed Archive

A published software must be packaged as a compressed archive file. This file archive can either be a single volume .ZIP compressed archive or a GZIP compressed tar archive. (These file formats are defined by the PKZIP APPNOTE specification, version 6.3.2, for the .ZIP compressed archive format, the IETF RFC1952 for the GZIP compressed format, and the POSIX.1 ustar definition for the tar archive format.)

In the remainder of this document, we will use the terms "zip archive" and "tar/gzip archive" for convenience.

Annex B of this document provides some examples of programs that can be used to produce such compressed archives.

1.2. Archive Name, Program Name and Version

The compressed archive file of a published software must be named according to the name_version.extension pattern, where:

  • name and version must consist only of lower case letters (a-z), digits (0-9), minus (-) and period (.) signs;
  • name must indicate the name of the program; this name can be the name of the executable program file, or another name, at the author's will;
  • version must start with a digit; it must indicate a version number for the program, in the sense that two different releases of the program must have two different version numbers; if no version numbering scheme is established for the program, the YYYYMMDD pattern based on the year, month and day of the release date may be used;
  • extension must be zip for zip archives and tar.gz or tgz for tar/gzip archives.

1.3. File and Folder Names

All the files and folders extracted from the compressed archive must be located inside a base folder named name_version, where name and version are identical to those used for the compressed archive file name. Absolute path must not be used for files and folders extracted from the archive.

The name of all files and folders composing the published software must consist only of lower or upper case letters (a-z, A-Z), digits (0-9), minus (-), underscore (_) and period (.) signs. They should start with a letter.

The names should provide a meaningful hint of the content of these files and folders.

1.4. Hidden and Useless Files

A published software should not include hidden files or folders or by-products of the tools used by the authors, such as (but not limited to):

  • files inserted by file managers (.DS_Store, .directory);
  • folders inserted by version control managers (.svn, .git);
  • backup versions (filename~, filename.bak).

The software should not be distributed with files not useful to build, use or study the implementation of the algorithm published in the journal.

2. Implementation

2.1. Source Code

A published software must include all the material necessary to build one or more executable program files implementing the algorithm published in the journal. This material must be provided in human-readable source code form. A published software must not be distributed with binary precompiled files if these files can be obtained from source code. (If the authors want to distribute binary versions, they can do it in the journal as supplementary material but not via the compressed archive of the published software covered by these guidelines.)

Annex C provides some information for the authors to help them perform some frequent implementation tasks.

2.2. Programming Language

The source code of a published software must follow the published standard syntax of one or more programming languages.

2.3. Portability

The source code of a published software must not require any extension of the language or its standard library, or any resource specific to a hardware environment, operating system or compiler. These extensions and resources may be used to achieve better performances if they are available but their availability must be detected during the compilation or execution and an alternative portable implementation must be used in their absence. This includes (but is not limited to)

  • language dialects specific to a compiler (GNU C, Microsoft C);
  • standard library functions specific to an implementation (drand48());
  • assembler code or "intrinsic functions" mapped to a processor instruction (mulps, __builtin_ia32_mulps());
  • computing on specialized hardware (GPGPU);
  • operating system calls (Win32 GetSystemTime(), POSIX gettimeofday());
  • file system locations (C:\Documents and Settings, /tmp);
  • code specific to a memory model environment (32-bits, 64-bits).

Special attention will be given to the Linux 64-bit environment because it is currently the primary environment for the web demos. But the program must also be usable in other environments and this portability must not be limited to the Win32/POSIX alternative.

2.4. External Libraries

A published software must not use external software components except for the libraries and APIs listed hereafter. The program may expect these basic software components to be correctly installed and configured during the compilation and execution:

  • libtiff version 3.x or 4.x and libpng version 1.4.x to read and write files, with their dependencies libjpeg version 8.x, zlib version 1.2.x;
  • fftw version 3.x (single and double precision) for Fourier transforms;
  • libgsl version 1.14+ for mathematical routines.
  • libeigen version 3.x for linear algebra. (Only the "official" Eigen modules are allowed, no code form the "unsupported" experimental section.)
  • cblas and clapack for linear algebra.

Other libraries can be examined and may be added to this list on request, if they are portable, widely used, with a stable API.

This restriction only applies to software components used by the published software but not distributed in source form with the program. Other libraries can be used if provided with the published software, as detailed in the next section.

2.5. Support Code

Authors may include some code from other software projects and libraries in their published software to reuse standard and well-defined algorithmic blocks, if it helps improve the quality of the implementation. This support code must follow the current implementation guidelines: distributed in source form, written in a standard programming language, portable, automatically compiled, without external dependencies except for the ones allowed.

To be reusable, the published software should only use the support code via calls to algorithmic functions, and should not be based on it. The function calls to this code should be clearly identified, with a description of their expected behavior.

This support code should be kept as small as possible; a huge library should not be involved for a tiny algorithm: to compute the eigenvalues of a 2×2 matrix, authors should not use a linear algebra library.

2.6. Usage and Input/Output

A published software should be minimal and only perform the algorithm published in the journal. It must be usable from the command line environment without any user interaction, taking all its parameters from the command line.

Annex C provides some information for the authors to help them use external libraries to read and write images.

2.7. Computing Resources

The program must not need more than 30 seconds to process typical data. For slow algorithms, this limit may be achieved with parallel processing or a limit on input size.

Annex C provides some information for the authors to help them improve the performance of their implementation and check the memory used.

3. Copyright, License and Patents

3.1. Copyright Attribution

Every source code file in a published software must mention its authors in a copyright attribution line at the top of the file. This mention may be omitted in trivial files such as header code.

Every person whose contribution to this file is not trivial and implies some creative work must be credited. Of course, if the authors use or modify a file previously written by other persons, the copyright attribution to the previous authors must not be removed. The copyright attribution must include the years of production of the work, the full name and an e-mail address for contributor. It may also include other relevant information such as the employer, affiliation or web site.

An simple example for a single author can be:

Copyright (C) 2011, Jane Doe <jane.doe@example.org>

A complex example with three contributors can be:

Copyright (C) 1998-2003, Taro Yamada <taro.yamada@example.jp>
Copyright (C) 2005-2011, Juan Perez <juan.perez@example.es>
Copyright (C) 2011,      Marie Untel, ENS Cachan
                         <marie.untel@ens-cachan.fr>

3.2. Patent Warning

When the authors are aware or suspect that a source code file implements an algorithm which might be linked to a patent (the main algorithm published in the journal or another algorithm used for this implementation), a patent warning must be inserted after the copyright attribution, in every file potentially linked to this patent. This wording is recommended:

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.

3.3. License

Every source code file must mention a usage and redistribution license after the copyright attribution (and patent warning for algorithms potentially linked to a patent). Of course, if the authors use or modify a file previously written by other persons, the license chosen by the previous authors must not be modified.

  • When the authors are not aware of a possible patent issue, the license must be one of the following free software licenses: GPL, LGPL, AGPL, BSD, or the CC0 dedication.
  • When a source code file can be linked to a patented algorithm and the source code authors are not the patent inventors, the file must be distributed under the BSD license or CC0 dedication.
  • When a source code file can be linked to a patented algorithm and the authors of the source code are the patent inventors, the file must be distributed either under the BSD license, the CC0 dedication or "for research and education only". (Distribution "for research and education" can help avoid conflicts between patent rights and software license when the patent inventors are the source code authors. It is not needed in other situations because the validity of the license will depend on the local patent regulations, as stated in the last sentence of the patent warning.)

These wordings are recommended:

This program is free software: you can use, modify and/or
redistribute it under the terms of the GNU General Public
License as published by the Free Software Foundation, either
version 3 of the License, or (at your option) any later
version. You should have received a copy of this license along
this program. If not, see <http://www.gnu.org/licenses/>.

This program is free software: you can use, modify and/or
redistribute it under the terms of the simplified BSD
License. You should have received a copy of this license along
this program. If not, see
<http://www.opensource.org/licenses/bsd-license.html>.

To the extent possible under law, the authors have dedicated all
copyright and related and neighboring rights to this software to
the public domain worldwide. This software is distributed without
any warranty. You should have received a copy of the CC0 Public
Domain Dedication along with this software. If not, see
<http://creativecommons.org/publicdomain/zero/1.0/>.

This program is provided for research and education only: you can
use and/or modify it for these purposes, but you are not allowed
to redistribute this work or derivative works in source or
executable form. A license must be obtained from the patent right
holders for any other use.

The exact terms can differ, for example when a different GPL/LGPL/AGPL license version is chosen. The full text of the license must be included in a separate file with the source code.

Authors should verify that the usage of these licenses for their software publications complies with their employer policy and local situation and jurisdiction.

4. Documentation

4.1. README.txt

Every published software must provide a file named README.txt in the base folder and written in plain text and in English. This README.txt file must include the following essential information, in any order:

  • name and brief description of the program
  • reference to the article
  • authors and contact information
  • version number and release date
  • location of future releases and updates
  • copyright, patent and license information
  • tools and libraries needed to compile and use the program
  • compilation instructions
  • usage instructions and example
  • changes in the software since it was first published
  • list of the files, mentioning which files are reviewed
  • list of known defects
  • credits and acknowledgments

If this information is too long, the README.txt file may be split: compilation instructions in INSTALL.txt, usage instructions and example in USAGE.txt, changes in the software in CHANGES.txt and list of files in MANIFEST.txt. These secondary information files must be referenced in README.txt.

The README.txt file may contain other information, and may also be completed by another documentation, possibly with more details, in text, PDF, HTML or any other format.

For a simple code, the license information in README.txt can be

This program is written by Jane Doe <jane.doe@example.org> and
distributed under the terms of the GPLv3 license.

A complex case (multiple authors, patents and licenses) can be:

This program is written by Taro Yamada <taro.yamada@example.jp>
and Juan Perez <juan.perez@example.es> with contributions from
Marie Untel, ENS Cachan <marie.untel@ens-cachan.fr>.
- mmatch.c and rot_tree.c may be linked to the pending EU patent
  123.456 by Taro Yamada and Juan Perez and are provided for
  scientific and education only.
- demoz.c may be linked to the US patent 65.43.21 by Jane Doe;
  see the file for license terms.
- eizo.c and linalg_lib.c are distributed under the terms
  of the BSD license.
- All the other files are distributed under the terms of the
  LGPLv3 license.

4.2. Readability

In a published software, the source code is a primary material for the publication. It will be reviewed, published and read like any other part of the article. The authors must take care of the clarity of their program.

The source code of a published software must be consistently indented and spaced. Lines should be limited to 80 characters and should not end with blank characters (spaces, tabs, ...). Files should not have more than 1000 lines. The line terminations should be the same (DOS/Windows CRLF or UNIX CR style) for all the files of the program.

Functions should be grouped by abstraction level in different source code files:

  • the main() function, command-line processing and input/output calls in one file,
  • the implementation of the algorithm described and reviewed in the article in one or more other files,
  • and the implementation of auxiliary and external routines in one or more other files.

Annex D provides some examples of programs that can be used to improve the indentation, spacing and presentation of a source code.

4.3. Implementation and Comments

The source code of a published software must be commented precisely and exhaustively. Authors should target the "1/8 comment/instruction ratio", but the quality of the comments is more important than the quantity. The source code must be written in English, including all variables, functions names and comments.

Authors must ensure that the code is understandable, to the satisfaction of the editor and reviewers, so that consistency between the description of the algorithm and its implementation can be verified. The relation between each part of the implementation and the respective part of the description of the algorithm must be explained in the comments.

Authors should apply simpler implementations when available, follow the conventions of the programming language, and use comments to explain implementation choices and every complicated or subtle point in the program. Clarity is more important than virtuosity.

Every function must be documented with at least one line explaining what the function is doing, and the meaning of its parameters and return value.

The Doxygen source code documentation format is recommended for every published software.

Annex D provides some examples of programs that can be used to count the comment, instruction and blank lines.

4.4. Example Data

The authors should provide an example of input file to test the published software and the result to expect when this input file is processed by the program.

Annexes

A. Key Words

The key words must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this document are to be interpreted as described in IETF RFC2119.

must ~ This word, or the terms required or shall, means that the definition is an absolute requirement. must not ~ This phrase, or the phrase shall not, means that the definition is an absolute prohibition.

No article will be published if a program included in this article doesn't follow such requirements or prohibitions.

should ~ This word, or the adjective recommended, means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course. should not ~ This phrase, or the phrase not recommended, means that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.

The rationale for not following such recommendations must be agreed by the authors, reviewers and editor before an article is accepted for publication.

may ~ This word, or the adjective optional, means that an item is truly optional. One author may choose to include the item because a particular article requires it or because the author feels that it enhances the software while another author may omit the same item.