Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
1 result
Name Last commit Last update
CITATION.cff
LICENSE
README.md
bib.bib
lhb-article.md
nfdi4earth-meta.yaml
proposal.pdf
README.md

Pilot-Template

Welcome to the NFDI4Earth community!

This template is designed to assist you in adhering to the FAIR principles and showcasing your project within the NFDI4Earth community.

Getting Started

Step 1: Get acess to the RWTH-AACHEN GitLab! Use a browser to access https://git.rwth-aachen.de and login either via the DFN AAI Single Sign-On if your institution supports this, or authenticate via Github (if you don't have DFN Login and no Github accound, please create an account under https://github.com/ and use this one). After you have initially logged in once into the RWTH Aachen Gitlab, send an email with your account name and the name of your Pilot to nfdi4earth-incubators@tu-dresden.de. You will then be granted access rights to the Gitlab project for your Pilot.

Step 2: Adapt the meta files, specifically the nfdi4earth-meta.yaml and the CITATION.cff, to ensure the findability of your project. nfdi4earth-meta.yaml is used to collect all metadata on your research project itself and the produced outcomes. CITATION.cff is used to collect metadata on one specific software and make it citable. You can either use this Gitlab project to host your software source code or if you are committing to an existing, external code repository please make sure there is a CITATION.cff and add the link to the nfdi4earth-meta.yaml. You can make the changes using the WEB-IDE or by cloning this repository.

Step 3: Update the README.md and lhb-article.md files. Initially, both files will be identical, but they may diverge as your project progresses. The content of the lhb-article.md will be highligthed through the Living Handbook (LHB). Begin by addressing the TODO items in the lhb-article.md, copying your proposal text to both files, and adapting links and headings using Markdown syntax. Later, the Living Handbook Article should providen an easy-to-understand overview of the project and your results. In contrast, the README.md may also be part of your final project report and for software projects, the README.md should highlight how to install and use the software.

References

Checkout the GitLab repositories and LHB articles of other (already completed) NFDI4Earth projects to get a sense of how to design your the README and article. Utilize the feature to evaluate repositories that serve as sources of inspiration.

Funding

This work has been funded by the German Research Foundation (NFDI4Earth, DFG project no. 460036893, https://www.nfdi4earth.de/).