SDC2 Reproducibility award

In this section we provide links for earch item in the reproducibility award check list.

Reproducibility of the solution check list

Well-documented

• [X] High-level description of what/who the software is for is available the HI-FRIENDS solution to the SDC2

• [X] High-level description of what the software does is available software general description

• [X] High-level description of how the software works is available workflow

• [X] Documentation consists of clear, step-by-step instructions workflow installation execution methodology

• [X] Documentation gives examples of what the user can see at each step e.g. screenshots or command-line excerpt execution

• [X] Documentation uses monospace fonts for command-line inputs and outputs, source code fragments, function names, class names etc workflow installation execution developers

• [X] Documentation is held under version control alongside the code repository

Easy to install

• [X] Full instructions provided for building and installing any software workflow installation

• [X] All dependencies are listed, along with web addresses, suitable versions, licences and whether they are mandatory or optional workflow installation. List of all required packages and their versions. Links to source code of each dependency including licenses when downloaded.

• [X] All dependencies are available. Links to source code of each dependency including licenses when downloaded.

• [X] Tests are provided to verify that the installation has succeeded. Unit tests, info unit tests

• [X] A containerised package is available, containing the code together with all of the related configuration files, libraries, and dependencies required. Using e.g. Docker/Singularity docker, singularity

Easy to use

• [X] A getting started guide is provided outlining a basic example of using the software e.g. a README file execution

• [X] Instructions are provided for many basic use cases. execution on a data cube

• [X] Reference guides are provided for all command-line, GUI and configuration options. basic usage execution on a data cube

Open licence

• [X] Software has an open source licence e.g. GNU General Public License (GPL), BSD 3-Clause license

• [X] License is stated in source code repository license

• [X] Each source code file has a licence header source code

Have easily accessible source code

• [X] Access to source code repository is available online repository

• [X] Repository is hosted externally in a sustainable third-party repository e.g. SourceForge, LaunchPad, GitHub: Introduction to GitHub repository

• [X] Documentation is provided for developers developers

Adhere to coding standards

• [X] Source code is laid out and indented well source code

• [X] Source code is commented source code

• [X] There is no commented out code source code

• [X] Source code is structured into modules or packages source code workflow file structure developers

• [X] Source code uses sensible class, package and variable names source code

• [X] Source code structure relates clearly to the architecture or design workflow file structure

Utilise tests

• [X] Source code has unit tests. Unit tests, info unit tests

• [X] Software recommends tools to check conformance to coding standards e.g. A ‘linter’ such as PyLint for Python. Pylint verification