Skip to content

Commit d183a35

Browse files
committed
Add Zenodo and citation information
1 parent 64c9922 commit d183a35

3 files changed

Lines changed: 33 additions & 19 deletions

File tree

CITATION.cff

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ title: "Monomer database datasets"
44
type: dataset
55
authors:
66
- name: "ProteinQure"
7+
doi: "10.5281/zenodo.21684534"
8+
version: "v1.0.0"
9+
date-released: 2026-07-29
710
repository-code: "https://github.com/ProteinQure/monomer-database-source"
811
url: "https://github.com/ProteinQure/monomer-database-datasets"
912
license: "CC-BY-SA-4.0"

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# Monomer database datasets
22

3+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21684533.svg)](https://doi.org/10.5281/zenodo.21684533)
4+
35
This repository contains versioned output formats for the monomer database.
46
The files are generated from the authoritative
57
[`monomer-database-source`](https://github.com/ProteinQure/monomer-database-source)
6-
repository and are intended for download and Zenodo archival.
7-
8-
The bootstrap commit intentionally contains no generated dataset. Publishing
9-
the source repository's initial `v0.0.1` release will create this repository's
10-
second commit and first tagged release, containing the 20 canonical amino
11-
acids. ProteinQure is identified as the organizational creator; see
8+
repository and are available for download and archival through Zenodo.
9+
ProteinQure is identified as the organizational creator; see
1210
[ZENODO.md](ZENODO.md).
1311

1412
## Download and verify
@@ -57,6 +55,11 @@ the checksums, and then creates the datasets GitHub release.
5755
`main` may advance after a release. A tag, GitHub release, or version-specific
5856
Zenodo DOI identifies an immutable snapshot.
5957

58+
The latest archived dataset is available from the
59+
[Zenodo record for all versions](https://doi.org/10.5281/zenodo.21684533).
60+
Version `v1.0.0` is permanently available at
61+
[doi:10.5281/zenodo.21684534](https://doi.org/10.5281/zenodo.21684534).
62+
6063
## Corrections and contributions
6164

6265
Do not directly edit generated files or propose data changes in this
@@ -68,13 +71,17 @@ Include the affected record identifiers and version or DOI. See
6871

6972
## Citation and licenses
7073

71-
ProteinQure is the organizational creator in `CITATION.cff` and
72-
`.zenodo.json`. Once the first Zenodo archive exists, this section should
73-
contain:
74+
When using version `v1.0.0`, cite the archived dataset:
7475

75-
1. the preferred dataset citation using the version-specific DOI;
76-
2. a Zenodo DOI badge linked to the concept DOI landing page; and
77-
3. links to both the latest Zenodo record and the source repository.
76+
> ProteinQure. (2026). *Monomer database datasets* (Version v1.0.0)
77+
> [Dataset]. Zenodo.
78+
> https://doi.org/10.5281/zenodo.21684534
79+
80+
For another version, use the citation and version-specific DOI on its Zenodo
81+
record. GitHub-readable citation metadata is provided in
82+
[`CITATION.cff`](CITATION.cff), and the authoritative data source is the
83+
[`monomer-database-source`](https://github.com/ProteinQure/monomer-database-source)
84+
repository.
7885

7986
The dataset, schema, and documentation are licensed under
8087
[Creative Commons Attribution-ShareAlike 4.0 International](LICENSE).

ZENODO.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The repository contains two active metadata files:
1212
as the organizational creator, applies CC BY-SA 4.0, supplies the title,
1313
description, English language, keywords, and related source repository.
1414
- `CITATION.cff` enables GitHub's citation interface and identifies ProteinQure
15-
as the organizational author.
15+
as the organizational author. It identifies the latest archived release,
16+
`v1.0.0`, with its version-specific DOI and publication date.
1617

1718
Zenodo gives `.zenodo.json` precedence when both files exist. Do not hard-code
1819
a release version in `.zenodo.json`; the GitHub release tag supplies it.
@@ -30,10 +31,13 @@ Contributors and roles, funding/grant identifiers, related publication DOIs,
3031
and a Zenodo community are currently omitted. Add them later if applicable;
3132
do not infer them from Git commit history.
3233

33-
## After the first archive
34+
## DOI records
3435

35-
Zenodo assigns a DOI to the specific release and a concept DOI representing all
36-
versions. Add the DOI badge supplied by Zenodo near the top of `README.md`,
37-
linked to the concept DOI landing page. Put the version-specific DOI in the
38-
preferred citation for that release. Update links without rewriting or
39-
retargeting an existing release tag.
36+
Zenodo assigned `10.5281/zenodo.21684534` to the immutable `v1.0.0` release and
37+
`10.5281/zenodo.21684533` as the concept DOI representing all versions. The
38+
badge in `README.md` links to the concept DOI, while the preferred citation and
39+
`CITATION.cff` use the version-specific DOI.
40+
41+
For a future release, update the preferred citation and release fields in
42+
`CITATION.cff` to the new version-specific Zenodo record. Do not rewrite or
43+
retarget an existing release tag.

0 commit comments

Comments
 (0)