From 8e6dade2cd08e244c475a3e75bda85ad81e06ef4 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Mon, 1 Dec 2025 12:26:58 +0000 Subject: [PATCH 1/5] Add citation file --- .gitignore | 3 +++ .pre-commit-config.yaml | 4 ++++ CITATION.cff | 25 +++++++++++++++++++++++++ 3 files changed, 32 insertions(+) create mode 100644 CITATION.cff diff --git a/.gitignore b/.gitignore index 6bfe303..d000526 100644 --- a/.gitignore +++ b/.gitignore @@ -95,6 +95,9 @@ venv.bak/ .spyderproject .spyproject +# pycharm project settings +.idea + # Rope project settings .ropeproject diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index de8a08f..c1efb63 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -73,3 +73,7 @@ repos: rev: v1.15.0 hooks: - id: mypy + - repo: https://github.com/citation-file-format/cffconvert + rev: 054bda51dbe278b3e86f27c890e3f3ac877d616c + hooks: + - id: validate-cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..ccae9e4 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,25 @@ +cff-version: 1.2.0 +title: "Zarr benchmarks" +version: 1.8.0 +license: "BSD-3" +type: software +abstract: "This repository provides advice on how to set Zarr array configuration options. +These options all have an impact on data compression, read times, and write times. +The advice here is based on a series of benchmarks, which are presented in the report." +message: "If you use this software, please cite it as below." +authors: + - given-names: David + family-names: Stansby + affiliation: University College London + orcid: "https://orcid.org/0000-0002-1365-1908" + - given-names: Kimberley + family-names: Meechan + affiliation: University College London + orcid: "https://orcid.org/0000-0003-4939-4170" + - given-names: Ruaridh + family-names: Gollifer + affiliation: University College London + orcid: "https://orcid.org/0000-0001-9319-936X8" +keywords: + - zarr + - data compression \ No newline at end of file From 62b657b2db364b798720f5946cc980786001285a Mon Sep 17 00:00:00 2001 From: David Stansby Date: Mon, 1 Dec 2025 12:28:32 +0000 Subject: [PATCH 2/5] Fix trailing whitespace --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index ccae9e4..89ce232 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -22,4 +22,4 @@ authors: orcid: "https://orcid.org/0000-0001-9319-936X8" keywords: - zarr - - data compression \ No newline at end of file + - data compression From 05e0229017be5a989c54803d0176ab4e67a79dec Mon Sep 17 00:00:00 2001 From: David Stansby Date: Wed, 3 Dec 2025 12:17:16 +0000 Subject: [PATCH 3/5] Fix name Co-authored-by: Kimberly Meechan <24316371+K-Meech@users.noreply.github.com> --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 89ce232..63564e2 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -12,7 +12,7 @@ authors: family-names: Stansby affiliation: University College London orcid: "https://orcid.org/0000-0002-1365-1908" - - given-names: Kimberley + - given-names: Kimberly family-names: Meechan affiliation: University College London orcid: "https://orcid.org/0000-0003-4939-4170" From 2669fe907dd27cd29d43855555db72c9f0d9d2a9 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Wed, 3 Dec 2025 17:21:58 +0000 Subject: [PATCH 4/5] Update version number --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 63564e2..3af3c7b 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,6 +1,6 @@ cff-version: 1.2.0 title: "Zarr benchmarks" -version: 1.8.0 +version: 1 license: "BSD-3" type: software abstract: "This repository provides advice on how to set Zarr array configuration options. From e419d53f0d69a31ab604c2c71f3b3eb10b40521a Mon Sep 17 00:00:00 2001 From: David Stansby Date: Wed, 3 Dec 2025 17:22:48 +0000 Subject: [PATCH 5/5] Fixes to citation file --- CITATION.cff | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 3af3c7b..e5135c3 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,11 +1,13 @@ cff-version: 1.2.0 title: "Zarr benchmarks" version: 1 -license: "BSD-3" +license: "BSD-3-Clause" type: software -abstract: "This repository provides advice on how to set Zarr array configuration options. -These options all have an impact on data compression, read times, and write times. -The advice here is based on a series of benchmarks, which are presented in the report." +abstract: + "This repository provides advice on how to set Zarr array configuration + options. These options all have an impact on data compression, read times, and + write times. The advice here is based on a series of benchmarks, which are + presented in the report." message: "If you use this software, please cite it as below." authors: - given-names: David