diff --git a/.github/workflows/citation.yml b/.github/workflows/citation.yml new file mode 100644 index 00000000..c64ab893 --- /dev/null +++ b/.github/workflows/citation.yml @@ -0,0 +1,23 @@ +name: Citation File Validation + +on: + push: + branches: [ "main", "dev", "hotfix/update-ci" ] + pull_request: + branches: [ "main", "dev", "hotfix/update-ci" ] + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + timeout-minutes: 20 + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v3 + - name: Install Checker + run: python3 -m pip install cffconvert + - name: Check Citation File + run: cffconvert --validate diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..92719c9d --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,44 @@ +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: Simvue +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Andrew + family-names: Lahiff + affiliation: United Kingdom Atomic Energy Authority + orcid: 'https://orcid.org/0000-0002-2785-4116' + - given-names: Aby + family-names: Abraham + affiliation: United Kingdom Atomic Energy Authority + - given-names: Vignesh + family-names: Gopakumar + orcid: 'https://orcid.org/0000-0002-6773-1049' + affiliation: United Kingdom Atomic Energy Authority + - given-names: Kristian + family-names: Zarebski + affiliation: United Kingdom Atomic Energy Authority + orcid: 'https://orcid.org/0000-0002-6773-1049' + - given-names: Matthew + family-names: Field + affiliation: United Kingdom Atomic Energy Authority + - given-names: James + family-names: Panayis + affiliation: United Kingdom Atomic Energy Authority +repository-code: 'https://github.com/simvue-io/client' +url: 'https://simvue.io/' +abstract: >- + Collect metadata, metrics and artifacts from simulations, + processing and AI/ML training tasks running on any + platform, in real time. +keywords: + - tracking + - monitoring + - metrics + - alerting + - simulation +license: Apache-2.0