Creating citable Code - Revision history

Kamil-braschke-0d3e@uni-wuppertal.de at 11:41, 14 July 2022

2022-07-14T11:41:10Z

Kamil-braschke-0d3e@uni-wuppertal.de: Kamil-braschke-0d3e@uni-wuppertal.de moved page Creating citable code to Creating citable Code: Capitalization was not according to the rest

2022-07-14T11:36:43Z

Kamil-braschke-0d3e@uni-wuppertal.de moved page Creating citable Code to Creating citable Code: Capitalization was not according to the rest

Kamil-braschke-0d3e@uni-wuppertal.de: /* Making Code citable */

2022-07-14T11:35:22Z

Making Code citable

Kamil-braschke-0d3e@uni-wuppertal.de: /* Links and more Information */

2022-07-14T11:32:04Z

Links and more Information

Kamil-braschke-0d3e@uni-wuppertal.de: /* Benefits of citable Code */

2022-07-14T11:30:18Z

Benefits of citable Code

Kamil-braschke-0d3e@uni-wuppertal.de at 11:06, 14 July 2022

2022-07-14T11:06:49Z

Kamil-braschke-0d3e@uni-wuppertal.de: /* Making Code citable */

2022-07-08T15:04:19Z

Making Code citable

Kamil-braschke-0d3e@uni-wuppertal.de at 15:04, 8 July 2022

2022-07-08T15:04:00Z

Kamil-braschke-0d3e@uni-wuppertal.de: /* Making Code citable */

2022-07-08T15:03:37Z

Making Code citable

Kamil-braschke-0d3e@uni-wuppertal.de at 15:01, 8 July 2022

2022-07-08T15:01:41Z

← Older revision		Revision as of 11:41, 14 July 2022
Line 1:		Line 1:
	[[Category:HPC-Developer]]		[[Category:HPC-Developer]]
−	Citability and reproducibility of scientific results have always been an integral part of research. More traditional aspects of research, including theoretical verification and experimental validation, have a long history of peer-reviewed publications, which enable referencing and reproduction by other parties. However, this often does not apply to any kind of self-written code, which is more and more common in every parts of research, from small evaluation scripts to whole software packages. Therefore, this page shall give a small overview of how to make your code citable and how to contribute to its reproducibility.	+	Citability and reproducibility of scientific results have always been an integral part of research. More traditional aspects of research, including theoretical verification and experimental validation, have a long history of peer-reviewed publications, which enable [[Citing Code\|referencing and reproduction by other parties]]. However, this often does not apply to any kind of self-written code, which is more and more common in every parts of research, from small evaluation scripts to whole software packages. Therefore, this page shall give a small overview of how to make your code citable and how to contribute to its reproducibility.

@@ Line 28: / Line 28: @@
 * related publications
-One way to get a DOI for your code is to use the GitHub integration of Zenodo. This of course requires your code to be published on GitHub. Please keep in mind that the DOI is only valid for one particular version of your code.
+One way to get a DOI for your code is to use the GitHub integration of Zenodo. This of course requires your code to be published on GitHub. Please keep in mind that the DOI is usually only valid for one particular version of your code.
 == Links and more Information ==

@@ Line 33: / Line 33: @@
 *[https://genr.eu/wp/cite/ Guide: Getting a DOI through Zenodo]
 *[https://www.gnu.org/licenses/licenses.en.html GNU General Public License]
 == References ==

@@ Line 13: / Line 13: @@
 * proper attribution and credit for the code development
 * depending on the license, other researchers are allowed to use the code for their own research including modifications and redistribution
 == Making Code citable ==

← Older revision		Revision as of 11:06, 14 July 2022
Line 1:		Line 1:
		+	[[Category:HPC-Developer]]
	Citability and reproducibility of scientific results have always been an integral part of research. More traditional aspects of research, including theoretical verification and experimental validation, have a long history of peer-reviewed publications, which enable referencing and reproduction by other parties. However, this often does not apply to any kind of self-written code, which is more and more common in every parts of research, from small evaluation scripts to whole software packages. Therefore, this page shall give a small overview of how to make your code citable and how to contribute to its reproducibility.		Citability and reproducibility of scientific results have always been an integral part of research. More traditional aspects of research, including theoretical verification and experimental validation, have a long history of peer-reviewed publications, which enable referencing and reproduction by other parties. However, this often does not apply to any kind of self-written code, which is more and more common in every parts of research, from small evaluation scripts to whole software packages. Therefore, this page shall give a small overview of how to make your code citable and how to contribute to its reproducibility.

@@ Line 15: / Line 15: @@
 == Making Code citable ==
 As mentioned above, the first step is to make your software publicly available on a platform of your choice. Preferable platforms contain some type of revision control, as in GitLab or GitHub, which is also beneficial to the overall development of your code. The publication should come with a clear license agreement (not just "open access" or "open source"), preferably it should include a license file and a description of the preferred way of referencing / citing the code. Generally any Creative Commons license should be avoided for code and if the code is intended to be free to use, then the GNU GPL can be a good choice.
-Once the code has been published with an appropriate license, its citability can be further improved upon through the addition of meta data. These include <ref name="NIH-FAQ"></ref><ref>Greg Wilson et al. “Good enough practices in scientific computing”. In: PLOS Computational Biology 13 (June 2017), pp. 1–20. doi: 10.1371/journal.pcbi.1005510.</ref> <ref>Neil P. Chue Hong et al. Software Citation Checklist for Developers. Version 0.9.0. Oct. 2019. doi:10.5281/zenodo.3482769.</ref>:
+Once the code has been published with an appropriate license, its citability can be further improved upon through the addition of meta data. These include <ref name="NIH-FAQ"></ref><ref>Greg Wilson et al. “Good enough practices in scientific computing”. In: PLOS Computational Biology 13 (June 2017), pp. 1–20. doi: 10.1371/journal.pcbi.1005510.</ref><ref>Neil P. Chue Hong et al. Software Citation Checklist for Developers. Version 0.9.0. Oct. 2019. doi:10.5281/zenodo.3482769.</ref>:
 * code version