How to make a software documentation “officially” citable? The Next CEO of Stack OverflowHow to quote a draft in my thesis?How to respond to intentional lack of citation?Selling/Buying software in academiaWriting PhD thesis as part of consortium projectWhere to draw the line for authorship for a software-announcement paper?Is there a citation network crawler [tool] for building a bibliography?How to review a software-tool paper?Is a software developer entitled to participate to paper?How to deal with your research results becoming obsolete?How to properly cite when using most of the text verbatim
Is a stroke of luck acceptable after a series of unfavorable events?
Whats the best way to handle refactoring a big file?
Why is there a PLL in CPU?
Unreliable Magic - Is it worth it?
I believe this to be a fraud - hired, then asked to cash check and send cash as Bitcoin
Describing a person. What needs to be mentioned?
How to safely derail a train during transit?
What's the point of interval inversion?
Example of a Mathematician/Physicist whose Other Publications during their PhD eclipsed their PhD Thesis
Trouble understanding the speech of overseas colleagues
Putting a 2D region plot under a 3D plot
Horror movie/show or scene where a horse creature opens its mouth really wide and devours a man in a stables
Text adventure game code
Is it safe to use c_str() on a temporary string?
What is the point of a new vote on May's deal when the indicative votes suggest she will not win?
When did Lisp start using symbols for arithmetic?
Return the Closest Prime Number
What does this shorthand mean?
Rotate a column
Go Pregnant or Go Home
How easy is it to start Magic from scratch?
Is it my responsibility to learn a new technology in my own time my employer wants to implement?
How to write papers efficiently when English isn't my first language?
Why does standard notation not preserve intervals (visually)
How to make a software documentation “officially” citable?
The Next CEO of Stack OverflowHow to quote a draft in my thesis?How to respond to intentional lack of citation?Selling/Buying software in academiaWriting PhD thesis as part of consortium projectWhere to draw the line for authorship for a software-announcement paper?Is there a citation network crawler [tool] for building a bibliography?How to review a software-tool paper?Is a software developer entitled to participate to paper?How to deal with your research results becoming obsolete?How to properly cite when using most of the text verbatim
We are currently finishing the implementation of a scientific software library. It's the first project of this type for me and I'm curious, how to make the software citable in a similar way to Molpro or R?
I was thinking about writing a short paper introducing the library, which could be subsequently cited. But I'm not sure, how to deal with the different versions? I don't think it's possible to write just some "changelog" paper once a year to summarize new released version.
citations authorship software software-papers
edited 13 hours ago
Massimo Ortolano
39.5k12119149
asked 13 hours ago
EenokuEenoku
1,1042920
add a comment |
We are currently finishing the implementation of a scientific software library. It's the first project of this type for me and I'm curious, how to make the software citable in a similar way to Molpro or R?
I was thinking about writing a short paper introducing the library, which could be subsequently cited. But I'm not sure, how to deal with the different versions? I don't think it's possible to write just some "changelog" paper once a year to summarize new released version.
citations authorship software software-papers
edited 13 hours ago
Massimo Ortolano
39.5k12119149
asked 13 hours ago
EenokuEenoku
1,1042920
add a comment |
We are currently finishing the implementation of a scientific software library. It's the first project of this type for me and I'm curious, how to make the software citable in a similar way to Molpro or R?
I was thinking about writing a short paper introducing the library, which could be subsequently cited. But I'm not sure, how to deal with the different versions? I don't think it's possible to write just some "changelog" paper once a year to summarize new released version.
citations authorship software software-papers
edited 13 hours ago
Massimo Ortolano
39.5k12119149
asked 13 hours ago
EenokuEenoku
1,1042920
We are currently finishing the implementation of a scientific software library. It's the first project of this type for me and I'm curious, how to make the software citable in a similar way to Molpro or R?
I was thinking about writing a short paper introducing the library, which could be subsequently cited. But I'm not sure, how to deal with the different versions? I don't think it's possible to write just some "changelog" paper once a year to summarize new released version.
citations authorship software software-papers
citations authorship software software-papers
edited 13 hours ago
Massimo Ortolano
39.5k12119149
asked 13 hours ago
EenokuEenoku
1,1042920
edited 13 hours ago
Massimo Ortolano
39.5k12119149
asked 13 hours ago
EenokuEenoku
1,1042920
edited 13 hours ago
Massimo Ortolano
39.5k12119149
edited 13 hours ago
Massimo Ortolano
39.5k12119149
edited 13 hours ago
Massimo Ortolano
39.5k12119149
39.5k12119149
asked 13 hours ago
EenokuEenoku
1,1042920
asked 13 hours ago
EenokuEenoku
1,1042920
asked 13 hours ago
EenokuEenoku
1,1042920
1,1042920
add a comment |
add a comment |
2 Answers
2
active
oldest
votes
There are about as many approaches to citing software (and making software citable) as there are software packages.
One way is to create a DOI for your software via Zenodo. This DOI can then be updated for each version of the software. Another way is to write a paper about the design and features of your software and see that it gets published somewhere. There are numerous journals for this -- for example, SoftwareX or, for mathematical software, the ACM Transactions on Mathematical Software. (Disclaimer: I'm a co-Editor-in-Chief of the latter.)
There are numerous other projects that have guidelines of how to best do this. You may want to take a look at the Force11 project, for example, as well as the outcomes of the WSSSPE series of workshops.
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
Thank you very much for the very informative answer, Wolfgang! I'd like to ask about ACM Transactions on Mathematical Software specific topics - is it possible to publish there about machine-learning software, but with emphasis to 1) improved training methods and 2) involvement of ANNs in numerical methods used in Quantum Chemistry?
– Eenoku
11 hours ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
10 hours ago
I'd have to see more of the paper to tell you whether what you want to do fits into TOMS. A single sentence is just not enough :-)
– Wolfgang Bangerth
10 hours ago
I'm afraid I don't have the paper yet, but we can discuss it before my first publication attempt :-)
– Eenoku
10 hours ago
1
Another important consideration is that the approach to use will also be influenced by the field the software is intended for. Conventions and details on how authors and journals like to handle software citations in field with heavy software usage (like statistics) are going to be different than a primarily non-computational field (like biochemistry).
– R.M.
8 hours ago
add a comment |
Write a manual and release it as a technical report.
how to deal with the different versions?
Put the version number in the manual's title and have a different version of the manual for every release. (Alternatively, revise the manual every major release or ...)
I don't think it's possible to write just some "changelog"
You could have a CHANGELOG in the manual, which summarises what's new in the current version. Alternatively, a CHANGELOG could be distributed with the software.
answered 12 hours ago
user2768user2768
14.9k33859
Ok, I suppose, that this it the case for Molpro software... But where do you officially publish a technical report? Otherwise yes, I know, that you can have aCHANGELOGin your repository, but that's not the place to be cited from :-)
– Eenoku
11 hours ago
Just publish the manual alongside the software. You could publish on arXiv, but that's not strictly necessary and adds an additional burden. Regarding theCHANGELOG, I'm not sure whether it needs to be cited, perhaps it suffices to just have different versions of the manual, one for each release.
– user2768
10 hours ago
add a comment |
Your Answer
StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "415"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);
else
createEditor();
);
function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
noCode: true, onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);
);
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2facademia.stackexchange.com%2fquestions%2f127204%2fhow-to-make-a-software-documentation-officially-citable%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
2 Answers
2
active
oldest
votes
2 Answers
2
active
oldest
votes
active
oldest
votes
active
oldest
votes
There are about as many approaches to citing software (and making software citable) as there are software packages.
One way is to create a DOI for your software via Zenodo. This DOI can then be updated for each version of the software. Another way is to write a paper about the design and features of your software and see that it gets published somewhere. There are numerous journals for this -- for example, SoftwareX or, for mathematical software, the ACM Transactions on Mathematical Software. (Disclaimer: I'm a co-Editor-in-Chief of the latter.)
There are numerous other projects that have guidelines of how to best do this. You may want to take a look at the Force11 project, for example, as well as the outcomes of the WSSSPE series of workshops.
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
Thank you very much for the very informative answer, Wolfgang! I'd like to ask about ACM Transactions on Mathematical Software specific topics - is it possible to publish there about machine-learning software, but with emphasis to 1) improved training methods and 2) involvement of ANNs in numerical methods used in Quantum Chemistry?
– Eenoku
11 hours ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
10 hours ago
I'd have to see more of the paper to tell you whether what you want to do fits into TOMS. A single sentence is just not enough :-)
– Wolfgang Bangerth
10 hours ago
I'm afraid I don't have the paper yet, but we can discuss it before my first publication attempt :-)
– Eenoku
10 hours ago
1
Another important consideration is that the approach to use will also be influenced by the field the software is intended for. Conventions and details on how authors and journals like to handle software citations in field with heavy software usage (like statistics) are going to be different than a primarily non-computational field (like biochemistry).
– R.M.
8 hours ago
add a comment |
There are about as many approaches to citing software (and making software citable) as there are software packages.
One way is to create a DOI for your software via Zenodo. This DOI can then be updated for each version of the software. Another way is to write a paper about the design and features of your software and see that it gets published somewhere. There are numerous journals for this -- for example, SoftwareX or, for mathematical software, the ACM Transactions on Mathematical Software. (Disclaimer: I'm a co-Editor-in-Chief of the latter.)
There are numerous other projects that have guidelines of how to best do this. You may want to take a look at the Force11 project, for example, as well as the outcomes of the WSSSPE series of workshops.
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
Thank you very much for the very informative answer, Wolfgang! I'd like to ask about ACM Transactions on Mathematical Software specific topics - is it possible to publish there about machine-learning software, but with emphasis to 1) improved training methods and 2) involvement of ANNs in numerical methods used in Quantum Chemistry?
– Eenoku
11 hours ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
10 hours ago
I'd have to see more of the paper to tell you whether what you want to do fits into TOMS. A single sentence is just not enough :-)
– Wolfgang Bangerth
10 hours ago
I'm afraid I don't have the paper yet, but we can discuss it before my first publication attempt :-)
– Eenoku
10 hours ago
1
Another important consideration is that the approach to use will also be influenced by the field the software is intended for. Conventions and details on how authors and journals like to handle software citations in field with heavy software usage (like statistics) are going to be different than a primarily non-computational field (like biochemistry).
– R.M.
8 hours ago
add a comment |
There are about as many approaches to citing software (and making software citable) as there are software packages.
One way is to create a DOI for your software via Zenodo. This DOI can then be updated for each version of the software. Another way is to write a paper about the design and features of your software and see that it gets published somewhere. There are numerous journals for this -- for example, SoftwareX or, for mathematical software, the ACM Transactions on Mathematical Software. (Disclaimer: I'm a co-Editor-in-Chief of the latter.)
There are numerous other projects that have guidelines of how to best do this. You may want to take a look at the Force11 project, for example, as well as the outcomes of the WSSSPE series of workshops.
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
There are about as many approaches to citing software (and making software citable) as there are software packages.
One way is to create a DOI for your software via Zenodo. This DOI can then be updated for each version of the software. Another way is to write a paper about the design and features of your software and see that it gets published somewhere. There are numerous journals for this -- for example, SoftwareX or, for mathematical software, the ACM Transactions on Mathematical Software. (Disclaimer: I'm a co-Editor-in-Chief of the latter.)
There are numerous other projects that have guidelines of how to best do this. You may want to take a look at the Force11 project, for example, as well as the outcomes of the WSSSPE series of workshops.
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
answered 12 hours ago
Wolfgang BangerthWolfgang Bangerth
35k469123
35k469123
Thank you very much for the very informative answer, Wolfgang! I'd like to ask about ACM Transactions on Mathematical Software specific topics - is it possible to publish there about machine-learning software, but with emphasis to 1) improved training methods and 2) involvement of ANNs in numerical methods used in Quantum Chemistry?
– Eenoku
11 hours ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
10 hours ago
I'd have to see more of the paper to tell you whether what you want to do fits into TOMS. A single sentence is just not enough :-)
– Wolfgang Bangerth
10 hours ago
I'm afraid I don't have the paper yet, but we can discuss it before my first publication attempt :-)
– Eenoku
10 hours ago
1
Another important consideration is that the approach to use will also be influenced by the field the software is intended for. Conventions and details on how authors and journals like to handle software citations in field with heavy software usage (like statistics) are going to be different than a primarily non-computational field (like biochemistry).
– R.M.
8 hours ago
add a comment |
Thank you very much for the very informative answer, Wolfgang! I'd like to ask about ACM Transactions on Mathematical Software specific topics - is it possible to publish there about machine-learning software, but with emphasis to 1) improved training methods and 2) involvement of ANNs in numerical methods used in Quantum Chemistry?
– Eenoku
11 hours ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
10 hours ago
I'd have to see more of the paper to tell you whether what you want to do fits into TOMS. A single sentence is just not enough :-)
– Wolfgang Bangerth
10 hours ago
I'm afraid I don't have the paper yet, but we can discuss it before my first publication attempt :-)
– Eenoku
10 hours ago
1
Another important consideration is that the approach to use will also be influenced by the field the software is intended for. Conventions and details on how authors and journals like to handle software citations in field with heavy software usage (like statistics) are going to be different than a primarily non-computational field (like biochemistry).
– R.M.
8 hours ago
Thank you very much for the very informative answer, Wolfgang! I'd like to ask about ACM Transactions on Mathematical Software specific topics - is it possible to publish there about machine-learning software, but with emphasis to 1) improved training methods and 2) involvement of ANNs in numerical methods used in Quantum Chemistry?
– Eenoku
11 hours ago
Thank you very much for the very informative answer, Wolfgang! I'd like to ask about ACM Transactions on Mathematical Software specific topics - is it possible to publish there about machine-learning software, but with emphasis to 1) improved training methods and 2) involvement of ANNs in numerical methods used in Quantum Chemistry?
– Eenoku
11 hours ago
1
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
10 hours ago
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
10 hours ago
I'd have to see more of the paper to tell you whether what you want to do fits into TOMS. A single sentence is just not enough :-)
– Wolfgang Bangerth
10 hours ago
I'd have to see more of the paper to tell you whether what you want to do fits into TOMS. A single sentence is just not enough :-)
– Wolfgang Bangerth
10 hours ago
I'm afraid I don't have the paper yet, but we can discuss it before my first publication attempt :-)
– Eenoku
10 hours ago
I'm afraid I don't have the paper yet, but we can discuss it before my first publication attempt :-)
– Eenoku
10 hours ago
1
1
Another important consideration is that the approach to use will also be influenced by the field the software is intended for. Conventions and details on how authors and journals like to handle software citations in field with heavy software usage (like statistics) are going to be different than a primarily non-computational field (like biochemistry).
– R.M.
8 hours ago
Another important consideration is that the approach to use will also be influenced by the field the software is intended for. Conventions and details on how authors and journals like to handle software citations in field with heavy software usage (like statistics) are going to be different than a primarily non-computational field (like biochemistry).
– R.M.
8 hours ago
add a comment |
Write a manual and release it as a technical report.
how to deal with the different versions?
Put the version number in the manual's title and have a different version of the manual for every release. (Alternatively, revise the manual every major release or ...)
I don't think it's possible to write just some "changelog"
You could have a CHANGELOG in the manual, which summarises what's new in the current version. Alternatively, a CHANGELOG could be distributed with the software.
answered 12 hours ago
user2768user2768
14.9k33859
Ok, I suppose, that this it the case for Molpro software... But where do you officially publish a technical report? Otherwise yes, I know, that you can have aCHANGELOGin your repository, but that's not the place to be cited from :-)
– Eenoku
11 hours ago
Just publish the manual alongside the software. You could publish on arXiv, but that's not strictly necessary and adds an additional burden. Regarding theCHANGELOG, I'm not sure whether it needs to be cited, perhaps it suffices to just have different versions of the manual, one for each release.
– user2768
10 hours ago
add a comment |
Write a manual and release it as a technical report.
how to deal with the different versions?
Put the version number in the manual's title and have a different version of the manual for every release. (Alternatively, revise the manual every major release or ...)
I don't think it's possible to write just some "changelog"
You could have a CHANGELOG in the manual, which summarises what's new in the current version. Alternatively, a CHANGELOG could be distributed with the software.
answered 12 hours ago
user2768user2768
14.9k33859
Ok, I suppose, that this it the case for Molpro software... But where do you officially publish a technical report? Otherwise yes, I know, that you can have aCHANGELOGin your repository, but that's not the place to be cited from :-)
– Eenoku
11 hours ago
Just publish the manual alongside the software. You could publish on arXiv, but that's not strictly necessary and adds an additional burden. Regarding theCHANGELOG, I'm not sure whether it needs to be cited, perhaps it suffices to just have different versions of the manual, one for each release.
– user2768
10 hours ago
add a comment |
Write a manual and release it as a technical report.
how to deal with the different versions?
Put the version number in the manual's title and have a different version of the manual for every release. (Alternatively, revise the manual every major release or ...)
I don't think it's possible to write just some "changelog"
You could have a CHANGELOG in the manual, which summarises what's new in the current version. Alternatively, a CHANGELOG could be distributed with the software.
answered 12 hours ago
user2768user2768
14.9k33859
Write a manual and release it as a technical report.
how to deal with the different versions?
Put the version number in the manual's title and have a different version of the manual for every release. (Alternatively, revise the manual every major release or ...)
I don't think it's possible to write just some "changelog"
You could have a CHANGELOG in the manual, which summarises what's new in the current version. Alternatively, a CHANGELOG could be distributed with the software.
answered 12 hours ago
user2768user2768
14.9k33859
answered 12 hours ago
user2768user2768
14.9k33859
answered 12 hours ago
user2768user2768
14.9k33859
answered 12 hours ago
user2768user2768
14.9k33859
14.9k33859
Ok, I suppose, that this it the case for Molpro software... But where do you officially publish a technical report? Otherwise yes, I know, that you can have aCHANGELOGin your repository, but that's not the place to be cited from :-)
– Eenoku
11 hours ago
Just publish the manual alongside the software. You could publish on arXiv, but that's not strictly necessary and adds an additional burden. Regarding theCHANGELOG, I'm not sure whether it needs to be cited, perhaps it suffices to just have different versions of the manual, one for each release.
– user2768
10 hours ago
add a comment |
Ok, I suppose, that this it the case for Molpro software... But where do you officially publish a technical report? Otherwise yes, I know, that you can have aCHANGELOGin your repository, but that's not the place to be cited from :-)
– Eenoku
11 hours ago
Just publish the manual alongside the software. You could publish on arXiv, but that's not strictly necessary and adds an additional burden. Regarding theCHANGELOG, I'm not sure whether it needs to be cited, perhaps it suffices to just have different versions of the manual, one for each release.
– user2768
10 hours ago
Ok, I suppose, that this it the case for Molpro software... But where do you officially publish a technical report? Otherwise yes, I know, that you can have a
CHANGELOG in your repository, but that's not the place to be cited from :-)– Eenoku
11 hours ago
Ok, I suppose, that this it the case for Molpro software... But where do you officially publish a technical report? Otherwise yes, I know, that you can have a
CHANGELOG in your repository, but that's not the place to be cited from :-)– Eenoku
11 hours ago
Just publish the manual alongside the software. You could publish on arXiv, but that's not strictly necessary and adds an additional burden. Regarding the
CHANGELOG, I'm not sure whether it needs to be cited, perhaps it suffices to just have different versions of the manual, one for each release.– user2768
10 hours ago
Just publish the manual alongside the software. You could publish on arXiv, but that's not strictly necessary and adds an additional burden. Regarding the
CHANGELOG, I'm not sure whether it needs to be cited, perhaps it suffices to just have different versions of the manual, one for each release.– user2768
10 hours ago
add a comment |
Thanks for contributing an answer to Academia Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2facademia.stackexchange.com%2fquestions%2f127204%2fhow-to-make-a-software-documentation-officially-citable%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
