Шаблон README для наборів даних обчислювальних матеріалів
Шаблон README для документування наборів даних обчислювальних матеріалів, включаючи опис робочого процесу, версії програмного забезпечення, вхідні та вихідні файли, параметри, походження, авторство, ліцензію та інформацію про репозиторій.
Resource type: Documentation template
Hosted / supported by: Центр компетенції даних FAIR для дослідження цифрових матеріалів
Мета
Цей шаблон допомагає дослідникам документувати набори даних обчислювальних матеріалів у зрозумілій та багаторазовій формі. Він призначений для наборів даних, отриманих за допомогою розрахунків DFT, атомістичних симуляцій, обчислювальних робочих процесів, скриптів, блокнотів та пов'язаних з ними дій моделювання.
Що він містить
Шаблон містить розділи для дослідницького завдання, системи матеріалів, обчислювального методу, програмного забезпечення та версій, опису робочого процесу, вхідних файлів, вихідних файлів, параметрів розрахунку, інформації про походження, авторства, ліцензії, запису в репозиторії та інформації про цитування.
Як він використовується
Дослідники та відповідальні за дані використовують цей шаблон під час підготовки обчислювальних наборів даних для депонування в репозиторії, призначення DOI, цитування та майбутнього повторного використання. Він допомагає користувачам зрозуміти, що було розраховано, які інструменти використовувалися, які файли включені та як результати можна перевірити або відтворити.
Рекомендоване використання
Використовуйте цей шаблон README разом із профілем набору даних обчислювальних матеріалів, контрольним списком метаданих та контрольним списком FAIR. Файл README слід заповнити перед депонуванням у репозиторії та включити до пакета набору даних разом із вхідними файлами, вихідними файлами, скриптами, блокнотами та записами метаданих.
Services using this resource
FAIR пакування наборів даних обчислювальних матеріалів
Цей сервіс допомагає користувачам готувати набори даних обчислювальних матеріалів для публікації, цитування та повторного використання. Він зосереджений на структуруванні файлів, документуванні робочих процесів, підготовці файлів README, створенні записів …
Підтримка README та DMP для користувачів ДІ
Цей сервіс допомагає користувачам ДІ підготувати файли README та документацію з планів управління даними для обчислювальних, експериментальних та змішаних наборів даних з матеріалознавства.
Підтримка планування обчислювальних робочих процесів
Цей сервіс допомагає дослідницьким групам планувати робочі процеси в галузі обчислювального матеріалознавства, включаючи визначення завдань, вибір програмного забезпечення, підготовку вхідних даних, документування результатів, фіксацію походження даних та планування …