FAIR Code Template for TU Delft

Link to the template repository: click here

The fair-code template was generated using the meta template to streamline the adoption of best software development practices in the NES domain.

By leveraging the meta template, essential files that help a project adhere to the FAIR principles, such as license files, CODE_OF_CONDUCT.md, README.md, and others were automatically included, eliminating the need for manual setup.

This also improves maintainability as updates in the meta template, such as changes in license files, can easily be updated using the following command:

copier update --answers-file .meta-answers.yml

Purpose

This template is designed so that researcher at TU Delft can make their software FAIR and compliant with the TU Delft Software Guidelines. While maintaining NES best practices, the structure was customized to fullfill the software guidelines.

How to Use

Your can quickly use this template as follows:

# Create a new project using the fair-code template
copier copy gh:manuGil/fair-code.git <my-software-project>

# Navigate to the project directory
cd <my-software-project>

# initialize a git repository
git init
git add .
git commit -m "Initial commit of my software project"

# start coding!

Note

This software template can be applied to preexisting research software projects using the copier copy command.

copier copy gh:manuGil/fair-code.git <./your-preexisting-project>