Skip to content

Commit d5ce577

Browse files
Fix CITATION.cff top-level metadata (#1921)
Related to #1916. This keeps the existing article citation as `preferred-citation`, and adds the required top-level CFF metadata for the software itself: `cff-version`, message, type, title, authors, repository, URL, license, and keywords. I intentionally did not change the existing preferred article citation. Local checks: - parsed `CITATION.cff` as YAML and checked that `cff-version` and `preferred-citation` are present; - `git diff --check`. I could not run `cffconvert --validate` locally because `cffconvert` is not installed in this environment. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added citation information for DP-GEN, including how to reference the software, project details, author information, repository and documentation links, license, and keywords. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 932afac commit d5ce577

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

CITATION.cff

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
cff-version: 1.2.0
2+
message: "If you use DP-GEN, please cite it using the metadata from this file."
3+
type: software
4+
title: "DP-GEN: A concurrent learning platform for the generation of reliable deep learning based potential energy models"
5+
abstract: "The deep potential generator to generate a deep-learning based model of interatomic potential energy and force field."
6+
authors:
7+
- name: "DeepModeling"
8+
- family-names: "Wang"
9+
given-names: "Han"
10+
email: "wang_han@iapcm.ac.cn"
11+
repository-code: "https://github.com/deepmodeling/dpgen"
12+
url: "https://docs.deepmodeling.com/projects/dpgen"
13+
license: LGPL-3.0-or-later
14+
keywords:
15+
- deep-potential-generator
16+
- active-learning
17+
- deepmd-kit
18+
119
preferred-citation:
220
type: article
321
authors:

0 commit comments

Comments
 (0)