Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CITATION file #44

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Add CITATION file #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adef0f4
Add CITATION file
willGraham01 Jan 30, 2024
6eb04c8
Update MANIFEST.in
willGraham01 Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: BrainGlobe
message: >-
You can use the brainglobe.cite() function to generate
citations for the BrainGlobe tools you use in your
research.
type: software
authors:
- given-names: BrainGlobe
family-names: Developers
affiliation: 'Sainsbury Wellcome Centre, University College London'
email: [email protected]
- given-names: Wiliam Michael
family-names: Graham
email: [email protected]
affiliation: 'Advanced Research Computing, University College London'
orcid: 'https://orcid.org/0000-0003-0058-263X'
repository-code: 'https://github.com/brainglobe/brainglobe-meta'
url: 'https://brainglobe.info/'
abstract: >-
The BrainGlobe Initiative exists to facilitate the
development of interoperable Python-based tools for
computational neuroanatomy.
license: BSD-3-Clause
citation-sentence: >-
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally our citation sentence would include version information too? Is that doable?

Copy link
Collaborator Author

@willGraham01 willGraham01 Jan 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can force the citation tool to include it when rendering the citation, if present in the metadata. If that'll suffice as a solution?

Have made this a to-do on brainglobe/brainglobe-utils#28 (comment)

'This project makes use of the BrainGlobe tool-suite, https://brainglobe.info/'
year: 2024
1 change: 1 addition & 0 deletions MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include CITATION.cff
include LICENSE
include README.md

Expand Down
Loading