Documentation

Jump to bottom

Antoine van Kampen edited this page Jul 24, 2024 · 11 revisions

The ENCORE documentation comprises several parts

Pre-defined files (component 2 in the figure below) that are found in all subdirectories of the ENCORE template. The pre-defined files contain instructions about the minimum information that needs to be provided in terms of documentation for the different parts of a project.
Step by Step ENCORE user guide (component 5): [here]. This guide provides instructions for new users on how to instantiate a new project. In addition it provides some basic background about GitHub (component 3).
Git/GitHub
* 'commits' and 'branches' [here]
See also ENCORE_AUTOMATION for scripts that automate specific ENCORE tasks.

ENCORE. ENhancing COmputational REproducibility