From 52bf1d6286958598272791898189c50c60112360 Mon Sep 17 00:00:00 2001 From: rythorpe Date: Tue, 19 Dec 2023 14:10:42 -0500 Subject: [PATCH 1/5] DOC: add JOSS badge to README.rst --- README.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 071866f28..916bcab4d 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ hnn-core ======== -|tests| |CircleCI| |Codecov| |PyPI| |Gitter| +|tests| |CircleCI| |Codecov| |PyPI| |Gitter| |JOSS| |HNN-GUI| @@ -195,3 +195,6 @@ Read our `roadmap`_. .. |Gitter| image:: https://badges.gitter.im/jonescompneurolab/hnn_core.svg :target: https://gitter.im/jonescompneurolab/hnn-core?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge + +.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.05848/status.svg + :target: https://doi.org/10.21105/joss.05848 \ No newline at end of file From b834e957d2d89ef59b4d706124bdd3499799f1dd Mon Sep 17 00:00:00 2001 From: rythorpe Date: Tue, 19 Dec 2023 14:11:44 -0500 Subject: [PATCH 2/5] add CITATION.cff --- CITATION.cff | 148 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..eb8408997 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,148 @@ +cff-version: "1.2.0" +authors: +- family-names: Jas + given-names: Mainak + orcid: "https://orcid.org/0000-0002-3199-9027" +- family-names: Thorpe + given-names: Ryan + orcid: "https://orcid.org/0000-0003-2491-8599" +- family-names: Tolley + given-names: Nicholas + orcid: "https://orcid.org/0000-0003-0358-0074" +- family-names: Bailey + given-names: Christopher + orcid: "https://orcid.org/0000-0003-3318-3344" +- family-names: Brandt + given-names: Steven +- family-names: Caldwell + given-names: Blake + orcid: "https://orcid.org/0000-0002-6882-6998" +- family-names: Cheng + given-names: Huzi +- family-names: Daniels + given-names: Dylan + orcid: "https://orcid.org/0009-0008-1958-353X" +- family-names: Pujol + given-names: Carolina Fernandez + orcid: "https://orcid.org/0009-0003-0611-1270" +- family-names: Khalil + given-names: Mostafa +- family-names: Kanekar + given-names: Samika + orcid: "https://orcid.org/0000-0002-6111-4461" +- family-names: Kohl + given-names: Carmen + orcid: "https://orcid.org/0000-0001-7585-595X" +- family-names: Kolozsvári + given-names: Orsolya + orcid: "https://orcid.org/0000-0002-1619-6314" +- family-names: Lankinen + given-names: Kaisu + orcid: "https://orcid.org/0000-0003-2210-2385" +- family-names: Loi + given-names: Kenneth +- family-names: Neymotin + given-names: Sam + orcid: "https://orcid.org/0000-0003-3646-5195" +- family-names: Partani + given-names: Rajat + orcid: "https://orcid.org/0000-0002-6863-7046" +- family-names: Pelah + given-names: Mattan +- family-names: Rockhill + given-names: Alex + orcid: "https://orcid.org/0000-0003-3868-7453" +- family-names: Sherif + given-names: Mohamed + orcid: "https://orcid.org/0000-0002-8951-1645" +- family-names: Hamalainen + given-names: Matti + orcid: "https://orcid.org/0000-0001-6841-112X" +- family-names: Jones + given-names: Stephanie + orcid: "https://orcid.org/0000-0001-6760-5301" +contact: +- family-names: Jones + given-names: Stephanie + orcid: "https://orcid.org/0000-0001-6760-5301" +doi: 10.5281/zenodo.10289164 +message: If you use this software, please cite our article in the + Journal of Open Source Software. +preferred-citation: + authors: + - family-names: Jas + given-names: Mainak + orcid: "https://orcid.org/0000-0002-3199-9027" + - family-names: Thorpe + given-names: Ryan + orcid: "https://orcid.org/0000-0003-2491-8599" + - family-names: Tolley + given-names: Nicholas + orcid: "https://orcid.org/0000-0003-0358-0074" + - family-names: Bailey + given-names: Christopher + orcid: "https://orcid.org/0000-0003-3318-3344" + - family-names: Brandt + given-names: Steven + - family-names: Caldwell + given-names: Blake + orcid: "https://orcid.org/0000-0002-6882-6998" + - family-names: Cheng + given-names: Huzi + - family-names: Daniels + given-names: Dylan + orcid: "https://orcid.org/0009-0008-1958-353X" + - family-names: Pujol + given-names: Carolina Fernandez + orcid: "https://orcid.org/0009-0003-0611-1270" + - family-names: Khalil + given-names: Mostafa + - family-names: Kanekar + given-names: Samika + orcid: "https://orcid.org/0000-0002-6111-4461" + - family-names: Kohl + given-names: Carmen + orcid: "https://orcid.org/0000-0001-7585-595X" + - family-names: Kolozsvári + given-names: Orsolya + orcid: "https://orcid.org/0000-0002-1619-6314" + - family-names: Lankinen + given-names: Kaisu + orcid: "https://orcid.org/0000-0003-2210-2385" + - family-names: Loi + given-names: Kenneth + - family-names: Neymotin + given-names: Sam + orcid: "https://orcid.org/0000-0003-3646-5195" + - family-names: Partani + given-names: Rajat + orcid: "https://orcid.org/0000-0002-6863-7046" + - family-names: Pelah + given-names: Mattan + - family-names: Rockhill + given-names: Alex + orcid: "https://orcid.org/0000-0003-3868-7453" + - family-names: Sherif + given-names: Mohamed + orcid: "https://orcid.org/0000-0002-8951-1645" + - family-names: Hamalainen + given-names: Matti + orcid: "https://orcid.org/0000-0001-6841-112X" + - family-names: Jones + given-names: Stephanie + orcid: "https://orcid.org/0000-0001-6760-5301" + date-published: 2023-12-15 + doi: 10.21105/joss.05848 + issn: 2475-9066 + issue: 92 + journal: Journal of Open Source Software + publisher: + name: Open Journals + start: 5848 + title: "HNN-core: A Python software for cellular and circuit-level + interpretation of human MEG/EEG" + type: article + url: "https://joss.theoj.org/papers/10.21105/joss.05848" + volume: 8 +title: "HNN-core: A Python software for cellular and circuit-level + interpretation of human MEG/EEG" From c95443bed0fc30d0c9912fcc99009f66923b87e9 Mon Sep 17 00:00:00 2001 From: rythorpe Date: Tue, 19 Dec 2023 14:33:12 -0500 Subject: [PATCH 3/5] DOC: add 'Citing' section to README.rst --- README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.rst b/README.rst index 916bcab4d..7f4b0411c 100644 --- a/README.rst +++ b/README.rst @@ -174,6 +174,16 @@ Roadmap Read our `roadmap`_. +Citing +====== + +If you use HNN-core in your work, please cite our +[publication in JOSS](https://doi.org/10.21105/joss.05848): + +> Jas et al., (2023). HNN-core: A Python software for cellular and +circuit-level interpretation of human MEG/EEG. *Journal of Open Source +Software*, 8(92), 5848, https://doi.org/10.21105/joss.05848 + .. _precompiled installers: https://www.neuron.yale.edu/neuron/download .. _NEURON forum: https://www.neuron.yale.edu/phpbb/ .. _contributing guide: https://jonescompneurolab.github.io/hnn-core/dev/contributing.html From f7f5d9b1b9b6f0d7646b6b82b5f8390e2d618e1d Mon Sep 17 00:00:00 2001 From: rythorpe Date: Tue, 19 Dec 2023 15:06:15 -0500 Subject: [PATCH 4/5] fix rst references --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 7f4b0411c..00ef58629 100644 --- a/README.rst +++ b/README.rst @@ -178,11 +178,11 @@ Citing ====== If you use HNN-core in your work, please cite our -[publication in JOSS](https://doi.org/10.21105/joss.05848): +`publication in JOSS `_:: -> Jas et al., (2023). HNN-core: A Python software for cellular and -circuit-level interpretation of human MEG/EEG. *Journal of Open Source -Software*, 8(92), 5848, https://doi.org/10.21105/joss.05848 + Jas et al., (2023). HNN-core: A Python software for cellular and + circuit-level interpretation of human MEG/EEG. *Journal of Open Source + Software*, 8(92), 5848, https://doi.org/10.21105/joss.05848 .. _precompiled installers: https://www.neuron.yale.edu/neuron/download .. _NEURON forum: https://www.neuron.yale.edu/phpbb/ From ffa287a8be3bb6eeb9f4d4f10cb41512ceac9ac2 Mon Sep 17 00:00:00 2001 From: rythorpe Date: Tue, 19 Dec 2023 15:59:01 -0500 Subject: [PATCH 5/5] DOC: format citation in README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 00ef58629..ee7a85b8a 100644 --- a/README.rst +++ b/README.rst @@ -178,7 +178,7 @@ Citing ====== If you use HNN-core in your work, please cite our -`publication in JOSS `_:: +`publication in JOSS `_: Jas et al., (2023). HNN-core: A Python software for cellular and circuit-level interpretation of human MEG/EEG. *Journal of Open Source