From 01edee24d6f79554c34862f8f92ee15f2c3fb4bc Mon Sep 17 00:00:00 2001 From: Stephanie Brink Date: Fri, 10 Nov 2023 13:16:18 -0800 Subject: [PATCH] add citation, update docs - point docs at github - fix LICENSE reference in README --- CITATION.cff | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 6 ++++-- 2 files changed, 54 insertions(+), 2 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..7b0f9437f --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,50 @@ +# If you are referencing Benchpark in a publication, please cite the paper +# described here. +# +# Here's the raw citation: +# +# Olga Pearce, Alec Scott, Gregory Becker, Riyaz Haque, Nathan Hanford, Stephanie Brink, +# Doug Jacobsen, Heidi Poxon, Jens Domke, and Todd Gamblin. 2023. +# Towards Collaborative Continuous Benchmarking for HPC. +# In Workshops of The International Conference on High Performance Computing, +# Network, Storage, and Analysis (SC-W 2023), November 12–17, 2023, Denver, CO, USA. +# ACM, New York, NY, USA, 9 pages. +# +# And here's the CITATION.cff format: + +cff-version: 1.2.0 +message: "If you are referencing Benchpark in a publication, please cite the paper below." +title: "Benchpark" +repository-code: "https://github.com/llnl/benchpark" +preferred-citation: + type: conference-paper + authors: + - family-names: "Pearce" + given-names: "Olga" + - family-names: "Scott" + given-names: "Alec" + - family-names: "Becker" + given-names: "Gregory" + - family-names: "Haque" + given-names: "Riyaz" + - family-names: "Hanford" + given-names: "Nathan" + - family-names: "Brink" + given-names: "Stephanie" + - family-names: "Jacobsen" + given-names: "Doug" + - family-names: "Poxon" + given-names: "Heidi" + - family-names: "Domke" + given-names: "Jens" + - family-names: "Gamblin" + given-names: "Todd" + title: "Towards Collaborative Continuous Benchmarking for HPC" + conference: + name: "Supercomputing 2023 (SC’23)" + city: "Denver" + region: "Colorado" + country: "USA" + month: November 12-17 + year: 2023 + notes: LLNL-CONF-853344 diff --git a/README.rst b/README.rst index 2b6a85b55..f1beb4dfd 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,9 @@ Benchpark ================================================== -You can find detailed documentation in `ReadTheDocs `_ +You can find detailed documentation in `ReadTheDocs +`_. Benchpark can also be found on `GitHub +`_. Benchpark is an open collaborative repository for reproducible specifications of HPC benchmarks. Benchpark enables cross-site collaboration on benchmarking by providing a mechanism for sharing @@ -62,6 +64,6 @@ ACM, New York, NY, USA, 9 pages. License ------- Benchpark is released under the Apache 2.0 w/ LLVM Exception license. For more -details see the [LICENSE](./LICENSE) file. +details see the [LICENSE](LICENSE) file. LLNL-CODE-850629