Skip to content

Commit cf370e2

Browse files
committed
docs: 📝 update CITATION.cff
Update citation metadata and improve `CITATION.cff` Enhances the `CITATION.cff` file by updating the citation message, adding contact details, keywords, license, repository links, and software type. Also refines author details and ORCID links for improved clarity and attribution. Expands `.cspell.json` dictionary with new words to accommodate updated metadata and ensure proper spell checking.
1 parent b439439 commit cf370e2

File tree

2 files changed

+35
-3
lines changed

2 files changed

+35
-3
lines changed

.cspell.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@
22
"version": "0.2",
33
"language": "en,en-GB",
44
"words": [
5+
"djmaxus",
6+
"Elizarev",
57
"Krevor",
6-
"PFLOTRAN"
8+
"Maksim",
9+
"Muggeridge",
10+
"orcid",
11+
"PFLOTRAN",
12+
"Senyou",
13+
"Wenck",
14+
"Zenodo"
715
],
816
"flagWords": [],
917
"ignorePaths": [

CITATION.cff

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# https://github.com/citation-file-format/citation-file-format
22
cff-version: 1.2.0
33
title: "StrataTrapper upscaling toolkit"
4-
message: "If you use this software, please cite it using these metadata."
4+
message: >-
5+
If you use this software,
6+
please put the copyright NOTICE.txt in your developments
7+
and cite using CITATION.cff provided in the repository
8+
or generated by Zenodo
59
authors:
610
- family-names: Elizarev
711
given-names: Maksim
812
alias: djmaxus
913
orcid: "https://orcid.org/0000-0002-5279-2877"
1014
website: "https://djmaxus.dev"
1115
- family-names: Jackson
12-
given-names: "Samuel J"
16+
given-names: Samuel J
1317
- family-names: An
1418
given-names: Senyou
1519
- family-names: Wenck
@@ -19,3 +23,23 @@ authors:
1923
- family-names: Krevor
2024
given-names: Samuel
2125
doi: "10.5281/zenodo.15438164"
26+
contact:
27+
- family-names: Elizarev
28+
given-names: Maksim
29+
- family-names: Krevor
30+
given-names: Samuel
31+
keywords:
32+
- matlab
33+
- co2
34+
- upscaling
35+
- carbon-dioxide
36+
- heterogeneity
37+
- reservoir-simulation
38+
- porous-media-flow
39+
- pflotran
40+
- capillary-pressure
41+
- co2-storage
42+
license: BSD-3-Clause
43+
repository-code: "https://github.com/ImperialCollegeLondon/StrataTrapper"
44+
type: software
45+
url: "https://imperialcollegelondon.github.io/StrataTrapper/"

0 commit comments

Comments
 (0)