From ba0bbc654439905cc7f6a30af53823695e3610d6 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Thu, 2 Sep 2021 13:44:20 +0200 Subject: [PATCH 1/6] add cff file, remove duplicates, include link to zenodo for all versions --- README.md | 61 ++----------------------------------- citation.cff | 15 +++++++++ doc/userdoc/citing-nest.rst | 21 ++----------- doc/userdoc/conf.py | 2 ++ 4 files changed, 23 insertions(+), 76 deletions(-) create mode 100644 citation.cff diff --git a/README.md b/README.md index be025772a0..8414562ccf 100644 --- a/README.md +++ b/README.md @@ -125,61 +125,6 @@ to find out how to install NEST. Please cite NEST if you use it in your work. -If you use NEST 3.0, please cite it as **Hahne, Jan et al. (2021). -NEST 3.0. Zenodo. 10.5281/zenodo.4739103**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.4739103). - -If you use NEST 2.20.1, please cite it as **Fardet, Tanguy et al. (2020) -NEST 2.20.1. Zenodo. 10.5281/zenodo.4018718**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.4018718). - -If you use NEST 2.20.0, please cite it as **Fardet, Tanguy et al. (2020) -NEST 2.20.0. Zenodo. 10.5281/zenodo.3605514**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.3605514). - -If you use NEST 2.18.0, please cite it as **Jordan, Jakob et al. (2019) -NEST 2.18.0. Zenodo. 10.5281/zenodo.2605422**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.2605422). - -If you use NEST 2.16.0, please cite it as **Linssen, Charl et al. (2018) -NEST 2.16.0. Zenodo. 10.5281/zenodo.1400175**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.1400175). - -If you use NEST 2.14.0, please cite it as **Peyser, Alexander et al. (2017). -NEST 2.14.0. Zenodo. 10.5281/zenodo.882971**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.882971). - -If you use NEST 2.12.0, please cite it as **Kunkel, Susanne et al. (2017). -NEST 2.12.0. Zenodo. 10.5281/zenodo.259534**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.259534). - -If you use NEST v2.10.0, please cite it as **Bos, Hannah et al. (2015). -NEST 2.10.0. Zenodo. 10.5281/zenodo.44222**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.44222). - -If you use NEST v2.8.0, please cite it as **Eppler, Jochen Martin et al. (2015). -NEST 2.8.0. Zenodo. 10.5281/zenodo.32969**. The full citation is available -in different formats on [Zenodo](https://doi.org/10.5281/zenodo.32969). - -For all versions below NEST v2.8.0 and for citing NEST without referring to a -specific version, please use: [Gewaltig M-O & Diesmann M (2007) NEST (Neural -Simulation Tool) Scholarpedia -2(4):1430](http://www.scholarpedia.org/article/NEST_(Neural_Simulation_Tool)). - -Here is a suitable BibTeX entry: - -```latex -@ARTICLE{Gewaltig:NEST, - author = {Marc-Oliver Gewaltig and Markus Diesmann}, - title = {NEST (NEural Simulation Tool)}, - journal = {Scholarpedia}, - year = {2007}, - volume = {2}, - pages = {1430}, - number = {4} -} -``` - -Please get in touch with us about your publications that used NEST, we will add -them to our [publication list](https://www.nest-simulator.org/publications), thus -making them visible to potential readers. +- You can find all the information for [citing NEST here](https://nest-simulator.readthedocs.io/lastest/citing-nest.html) + + diff --git a/citation.cff b/citation.cff new file mode 100644 index 0000000000..0deeaede06 --- /dev/null +++ b/citation.cff @@ -0,0 +1,15 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: +- family-names: "Lisa" + given-names: "Mona" + orcid: "https://orcid.org/0000-0000-0000-0000" +- family-names: "Bot" + given-names: "Hew" + orcid: "https://orcid.org/0000-0000-0000-0000" +title: "NEST Simulator" +version: 3.0 +doi: 10.5281/zenodo.4739103 +date-release: June 10, 2021 +url: "https://github.com/nest/nest-simulator" + diff --git a/doc/userdoc/citing-nest.rst b/doc/userdoc/citing-nest.rst index a15413de4f..0255e1c07a 100644 --- a/doc/userdoc/citing-nest.rst +++ b/doc/userdoc/citing-nest.rst @@ -3,31 +3,16 @@ Cite NEST ========= -Please cite NEST if you use it in your work. You can :doc:`let us know ` about your publications that used NEST, and we +Please cite the version of NEST you used in your work. You can :doc:`let us know ` about your publications that used NEST, and we will add them to our `publication list `_; this will help make them visible to potential readers. -For the full citation and additional formats follow the doi Zenodo link. +For all versions from 2.8 onwards, you can find the full citation `on Zenondo `_ -Cite the version you used in your work: -Hahne, Jan et al. (2021). **NEST 3.0** Zenodo. https://doi.org/10.5281/zenodo.4739103 -Fardet, Tanguy et al. (2020). **NEST 2.20.1** Zenodo. https://doi.org/10.5281/zenodo.4018718 -Fardet, Tanguy et al. (2020). **NEST 2.20.0** Zenodo. https://doi.org/10.5281/zenodo.3605514 - -Jordan, Jakob et al. (2019). **NEST 2.18.0** Zenodo. https://doi.org/10.5281/zenodo.2605422 - -Linssen, Charl et al. (2018). **NEST 2.16.0** Zenodo. https://doi.org/10.5281/zenodo.1400175 - -Peyser, Alexander et al. (2017). **NEST 2.14.0** Zenodo. https://doi.org/10.5281/zenodo.882971 - -Kunkel, Susanne et al. (2017). **NEST 2.12.0** Zenodo. https://doi.org/10.5281/zenodo.259534 - -Bos, Hannah et al. (2015). **NEST 2.10.0** Zenodo. https://doi.org/10.5281/zenodo.44222 - -Eppler, Jochen Martin et al. (2015). **NEST 2.8.0** Zenodo. https://doi.org/10.5281/zenodo.32969 +---- For all versions below NEST 2.8.0 and for citing NEST without referring to a specific version, please use: `Gewaltig M-O & Diesmann M (2007) NEST (Neural Simulation Tool) Scholarpedia diff --git a/doc/userdoc/conf.py b/doc/userdoc/conf.py index 1d5b8c7b6b..152c8e630d 100644 --- a/doc/userdoc/conf.py +++ b/doc/userdoc/conf.py @@ -148,6 +148,7 @@ numfig_secnum_depth = (2) numfig_format = {'figure': 'Figure %s', 'table': 'Table %s', 'code-block': 'Code Block %s'} + # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -294,6 +295,7 @@ def copy_acknowledgments_file(src): # -- Copy Acknowledgments file ---------------------------- copy_acknowledgments_file(source_dir / "ACKNOWLEDGMENTS.md") + # -- Copy documentation for Microcircuit Model ---------------------------- copy_example_file(source_dir / "pynest/examples/Potjans_2014/box_plot.png") copy_example_file(source_dir / "pynest/examples/Potjans_2014/raster_plot.png") From ed87fbb85ab415336a88fc4459b2e788e8342688 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Fri, 3 Sep 2021 08:56:25 +0200 Subject: [PATCH 2/6] fix link readme, remove cff for now --- README.md | 2 +- citation.cff | 15 --------------- 2 files changed, 1 insertion(+), 16 deletions(-) delete mode 100644 citation.cff diff --git a/README.md b/README.md index 8414562ccf..90a76ec4a4 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,6 @@ to find out how to install NEST. Please cite NEST if you use it in your work. -- You can find all the information for [citing NEST here](https://nest-simulator.readthedocs.io/lastest/citing-nest.html) +- You can find all the information for [citing NEST here](https://nest-simulator.readthedocs.io/en/lastest/citing-nest.html) diff --git a/citation.cff b/citation.cff deleted file mode 100644 index 0deeaede06..0000000000 --- a/citation.cff +++ /dev/null @@ -1,15 +0,0 @@ -cff-version: 1.2.0 -message: "If you use this software, please cite it as below." -authors: -- family-names: "Lisa" - given-names: "Mona" - orcid: "https://orcid.org/0000-0000-0000-0000" -- family-names: "Bot" - given-names: "Hew" - orcid: "https://orcid.org/0000-0000-0000-0000" -title: "NEST Simulator" -version: 3.0 -doi: 10.5281/zenodo.4739103 -date-release: June 10, 2021 -url: "https://github.com/nest/nest-simulator" - From f76320dafc07c42139940f63ebc46227b609bfb2 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Fri, 3 Sep 2021 11:13:56 +0200 Subject: [PATCH 3/6] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 90a76ec4a4..93a4727f2f 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,6 @@ to find out how to install NEST. Please cite NEST if you use it in your work. -- You can find all the information for [citing NEST here](https://nest-simulator.readthedocs.io/en/lastest/citing-nest.html) +- You can find all the information for [citing NEST here](https://nest-simulator.readthedocs.io/en/latest/citing-nest.html) From 5b394d544ae0704123f4c156ea0fc71a547f8e88 Mon Sep 17 00:00:00 2001 From: jessica-mitchell Date: Fri, 3 Sep 2021 12:51:19 +0200 Subject: [PATCH 4/6] Update doc/userdoc/citing-nest.rst Co-authored-by: Hans Ekkehard Plesser --- doc/userdoc/citing-nest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/userdoc/citing-nest.rst b/doc/userdoc/citing-nest.rst index 0255e1c07a..a100e58954 100644 --- a/doc/userdoc/citing-nest.rst +++ b/doc/userdoc/citing-nest.rst @@ -7,7 +7,7 @@ Please cite the version of NEST you used in your work. You can :doc:`let us know will add them to our `publication list `_; this will help make them visible to potential readers. -For all versions from 2.8 onwards, you can find the full citation `on Zenondo `_ +For all versions from 2.8 onwards, you can find the full citation `on Zenondo `_ From 25a0c59fbaa2ff10be8179b48119d585dd4d05ab Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Mon, 6 Sep 2021 10:19:02 +0200 Subject: [PATCH 5/6] apply suggestions from review --- doc/userdoc/citing-nest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/userdoc/citing-nest.rst b/doc/userdoc/citing-nest.rst index 0255e1c07a..644f930d94 100644 --- a/doc/userdoc/citing-nest.rst +++ b/doc/userdoc/citing-nest.rst @@ -7,7 +7,7 @@ Please cite the version of NEST you used in your work. You can :doc:`let us know will add them to our `publication list `_; this will help make them visible to potential readers. -For all versions from 2.8 onwards, you can find the full citation `on Zenondo `_ +For all versions from 2.8 onwards, you can find the full citation `on Zenondo `_. From e2cedf6353fa059f64004ae5e078c42798d6f509 Mon Sep 17 00:00:00 2001 From: Dennis Terhorst Date: Wed, 15 Sep 2021 10:03:54 +0200 Subject: [PATCH 6/6] Update doc/userdoc/conf.py --- doc/userdoc/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/userdoc/conf.py b/doc/userdoc/conf.py index 152c8e630d..6643657122 100644 --- a/doc/userdoc/conf.py +++ b/doc/userdoc/conf.py @@ -294,8 +294,6 @@ def copy_acknowledgments_file(src): # -- Copy Acknowledgments file ---------------------------- copy_acknowledgments_file(source_dir / "ACKNOWLEDGMENTS.md") - - # -- Copy documentation for Microcircuit Model ---------------------------- copy_example_file(source_dir / "pynest/examples/Potjans_2014/box_plot.png") copy_example_file(source_dir / "pynest/examples/Potjans_2014/raster_plot.png")