Added citation and fair badge

bioexcel · Apr 30, 2024 · 997a1ad · 997a1ad
1 parent 3409550
commit 997a1ad
Show file tree

Hide file tree

Showing 5 changed files with 104 additions and 5 deletions.
diff --git a/.github/workflows/linting_and_testing.yml b/.github/workflows/linting_and_testing.yml
@@ -10,6 +10,7 @@ on:
       - 'LICENSE'
       - 'setup.py'
       - 'README.md'
+      - 'CITATION.cff'
       - 'references.jsonld'
       - '**/docs/**'
       - '**/json_schemas/**'

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,84 @@
+# YAML 1.2
+---
+abstract: "BioExcel Building Blocks (BioBB) library. BioBB’s are built as Python wrappers to provide an interoperable architecture. BioBB’s have been integrated in a chain of usual software management tools to generate data ontologies, documentation, installation packages, software containers and ways of integration with workflow managers, that make them usable in most computational environments."
+authors:
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC)"
+    family-names: "Andrio"
+    given-names: "Pau"
+    orcid: "https://orcid.org/0000-0003-2116-3880"
+  -
+    affiliation: "Institute for Research in Biomedicine (IRB Barcelona)"
+    family-names: "Hospital"
+    given-names: "Adam"
+    orcid: "https://orcid.org/0000-0002-8291-8071"
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC)"
+    family-names: "Conejero"
+    given-names:  "Javier"
+    orcid: "https://orcid.org/0000-0001-6401-6229"
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC)"
+    family-names: "Jordà"
+    given-names: "Luis"
+    orcid: "https://orcid.org/0000-0002-9407-9703"
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC)"
+    family-names: "Del Pino"
+    given-names: "Marc"
+    orcid: "https://orcid.org/0000-0001-5565-7577"
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC)"
+    family-names: "Laia"
+    given-names: "Codó"
+    orcid: "https://orcid.org/0000-0002-6797-8746"
+  -
+    affiliation: "School of computer Science, the University of Manchester"
+    family-names: Werkhoven
+    given-names: Ben
+    name-particle: van
+    orcid: "https://orcid.org/0000-0002-7508-3272"
+  -
+    affiliation: "University of Manchester (UOM)"
+    family-names: "Soiland-Reyes"
+    given-names: "Stian"
+    orcid: "https://orcid.org/0000-0001-9842-9718"
+  -
+    affiliation: "University of Manchester (UOM)"
+    family-names: "Goble"
+    given-names: "Carole"
+    orcid: "https://orcid.org/0000-0003-1219-2137"
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC)"
+    family-names: "Lezzi"
+    given-names: "Daniele"
+    orcid: "https://orcid.org/0000-0001-5081-7244"
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC)"
+    family-names: "Rosa M"
+    given-names: "Badia"
+    orcid: "https://orcid.org/0000-0003-2941-5499"
+  -
+    affiliation: "Institute for Research in Biomedicine (IRB Barcelona), University of Barcelona (UB)"
+    family-names: "Orozco"
+    given-names: "Modesto"
+    orcid: "https://orcid.org/0000-0002-8608-3278"
+  -
+    affiliation: "Barcelona Supercomputing Center (BSC), University of Barcelona (UB)"
+    family-names: "Gelpí"
+    given-names: "Josep Ll."
+    orcid: "https://orcid.org/0000-0002-0566-7723"
+    email: "gelpi@ub.edu"
+
+cff-version: "1.2.0"
+date-released: "2019-09-10"
+keywords:
+  - "BioExcel"
+  - "BioBB"
+  - "Bioinformatics"
+  - "Computational Biology"
+  - "Biomolecular Workflows"
+license: "Apache-2.0"
+message: "If you use this software, please cite it using these metadata."
+repository-code: "https://github.com/bioexcel/biobb"
+title: "BioExcel Building Blocks, a software library for interoperable biomolecular simulation workflows"
diff --git a/README.md b/README.md
@@ -22,6 +22,13 @@
 [![](https://img.shields.io/github/last-commit/bioexcel/biobb_ml?label=Last%20Commit)](https://github.com/bioexcel/biobb_ml/commits/master)
 [![](https://img.shields.io/github/issues/bioexcel/biobb_ml.svg?color=brightgreen&label=Issues)](https://GitHub.com/bioexcel/biobb_ml/issues/)
 
+[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)
+[![](https://www.bestpractices.dev/projects/8847/badge)](https://www.bestpractices.dev/projects/8847)
+
+[](https://bestpractices.coreinfrastructure.org/projects/8847/badge)
+
+[//]: # (The previous line invisible link is for compatibility with the howfairis script https://github.com/fair-software/howfairis-github-action/tree/main wich uses the old bestpractices URL)
+
 # biobb_ml
 
 ### Introduction
@@ -93,8 +100,8 @@ The command list and specification can be found at the [Command Line documentati
 ### Copyright & Licensing
 This software has been developed in the [MMB group](http://mmb.irbbarcelona.org) at the [BSC](http://www.bsc.es/) & [IRB](https://www.irbbarcelona.org/) for the [European BioExcel](http://bioexcel.eu/), funded by the European Commission (EU H2020 [823830](http://cordis.europa.eu/projects/823830), EU H2020 [675728](http://cordis.europa.eu/projects/675728)).
 
-* (c) 2015-2023 [Barcelona Supercomputing Center](https://www.bsc.es/)
-* (c) 2015-2023 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)
+* (c) 2015-2024 [Barcelona Supercomputing Center](https://www.bsc.es/)
+* (c) 2015-2024 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)
 
 Licensed under the
 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file LICENSE for details.

diff --git a/biobb_ml/docs/source/conf.py b/biobb_ml/docs/source/conf.py
@@ -68,7 +68,7 @@
 
 # General information about the project.
 project = u'biobb_ml'
-copyright = u'2023, Bioexcel Project'
+copyright = u'2024, Bioexcel Project'
 author = u'Bioexcel Project'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/biobb_ml/docs/source/readme.md b/biobb_ml/docs/source/readme.md
@@ -22,6 +22,13 @@
 [![](https://img.shields.io/github/last-commit/bioexcel/biobb_ml?label=Last%20Commit)](https://github.com/bioexcel/biobb_ml/commits/master)
 [![](https://img.shields.io/github/issues/bioexcel/biobb_ml.svg?color=brightgreen&label=Issues)](https://GitHub.com/bioexcel/biobb_ml/issues/)
 
+[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)
+[![](https://www.bestpractices.dev/projects/8847/badge)](https://www.bestpractices.dev/projects/8847)
+
+[](https://bestpractices.coreinfrastructure.org/projects/8847/badge)
+
+[//]: # (The previous line invisible link is for compatibility with the howfairis script https://github.com/fair-software/howfairis-github-action/tree/main wich uses the old bestpractices URL)
+
 # biobb_ml
 
 ### Introduction
@@ -93,8 +100,8 @@ The command list and specification can be found at the [Command Line documentati
 ### Copyright & Licensing
 This software has been developed in the [MMB group](http://mmb.irbbarcelona.org) at the [BSC](http://www.bsc.es/) & [IRB](https://www.irbbarcelona.org/) for the [European BioExcel](http://bioexcel.eu/), funded by the European Commission (EU H2020 [823830](http://cordis.europa.eu/projects/823830), EU H2020 [675728](http://cordis.europa.eu/projects/675728)).
 
-* (c) 2015-2023 [Barcelona Supercomputing Center](https://www.bsc.es/)
-* (c) 2015-2023 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)
+* (c) 2015-2024 [Barcelona Supercomputing Center](https://www.bsc.es/)
+* (c) 2015-2024 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)
 
 Licensed under the
 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file LICENSE for details.