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
How do I make a variable always equal to the result of some calculations?
How does the mv command work with external drives?
What does convergence in distribution "in the Gromov–Hausdorff" sense mean?
WOW air has ceased operation, can I get my tickets refunded?
Why do professional authors make "consistency" mistakes? And how to avoid them?
Can we say or write : "No, it'sn't"?
Why don't programming languages automatically manage the synchronous/asynchronous problem?
How to avoid supervisors with prejudiced views?
Is there a way to save my career from absolute disaster?
Written every which way
How fast would a person need to move to trick the eye?
Won the lottery - how do I keep the money?
Contours of a clandestine nature
What can we do to stop prior company from asking us questions?
Phase of a real number
If the heap is initialized for security, then why is the stack uninitialized?
I believe this to be a fraud - hired, then asked to cash check and send cash as Bitcoin
Inappropriate reference requests from Journal reviewers
How do I avoid eval and parse?
Several mode to write the symbol of a vector
Why do remote companies require working in the US?
What happened in Rome, when the western empire "fell"?
Would this house-rule that treats advantage as a +1 to the roll instead (and disadvantage as -1) and allows them to stack be balanced?
Is it possible to search for a directory/file combination?
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 yesterday
Massimo Ortolano
39.5k12119149
asked yesterday
EenokuEenoku
1,12421020
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 yesterday
Massimo Ortolano
39.5k12119149
asked yesterday
EenokuEenoku
1,12421020
3
I don't understand the question. Your software is already citable, by listing your name, the name of the library, and the URL.
– JeffE
19 hours ago
@JeffE That's the truth, but it's not going to be indexed anywhere, not even Google Scholar, if I'll have just the name and URL...
– Eenoku
18 hours ago
1
@Eenoku Are you sure that Google Scholar won't index? If your software is consistently cited---e.g., Eenoku (2019) Library, http://url.com---then surely Google will index that.
– user2768
17 hours ago
1
You may be wrong. Google Scholar reports that a subset of my lecture notes, which is only published as PDFs on my web page, has 5 citations.
– JeffE
15 hours ago
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 yesterday
Massimo Ortolano
39.5k12119149
asked yesterday
EenokuEenoku
1,12421020
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 yesterday
Massimo Ortolano
39.5k12119149
asked yesterday
EenokuEenoku
1,12421020
edited yesterday
Massimo Ortolano
39.5k12119149
asked yesterday
EenokuEenoku
1,12421020
edited yesterday
Massimo Ortolano
39.5k12119149
edited yesterday
Massimo Ortolano
39.5k12119149
edited yesterday
Massimo Ortolano
39.5k12119149
39.5k12119149
asked yesterday
EenokuEenoku
1,12421020
asked yesterday
EenokuEenoku
1,12421020
asked yesterday
EenokuEenoku
1,12421020
1,12421020
3
I don't understand the question. Your software is already citable, by listing your name, the name of the library, and the URL.
– JeffE
19 hours ago
@JeffE That's the truth, but it's not going to be indexed anywhere, not even Google Scholar, if I'll have just the name and URL...
– Eenoku
18 hours ago
1
@Eenoku Are you sure that Google Scholar won't index? If your software is consistently cited---e.g., Eenoku (2019) Library, http://url.com---then surely Google will index that.
– user2768
17 hours ago
1
You may be wrong. Google Scholar reports that a subset of my lecture notes, which is only published as PDFs on my web page, has 5 citations.
– JeffE
15 hours ago
add a comment |
3
I don't understand the question. Your software is already citable, by listing your name, the name of the library, and the URL.
– JeffE
19 hours ago
@JeffE That's the truth, but it's not going to be indexed anywhere, not even Google Scholar, if I'll have just the name and URL...
– Eenoku
18 hours ago
1
@Eenoku Are you sure that Google Scholar won't index? If your software is consistently cited---e.g., Eenoku (2019) Library, http://url.com---then surely Google will index that.
– user2768
17 hours ago
1
You may be wrong. Google Scholar reports that a subset of my lecture notes, which is only published as PDFs on my web page, has 5 citations.
– JeffE
15 hours ago
3
3
I don't understand the question. Your software is already citable, by listing your name, the name of the library, and the URL.
– JeffE
19 hours ago
I don't understand the question. Your software is already citable, by listing your name, the name of the library, and the URL.
– JeffE
19 hours ago
@JeffE That's the truth, but it's not going to be indexed anywhere, not even Google Scholar, if I'll have just the name and URL...
– Eenoku
18 hours ago
@JeffE That's the truth, but it's not going to be indexed anywhere, not even Google Scholar, if I'll have just the name and URL...
– Eenoku
18 hours ago
1
1
@Eenoku Are you sure that Google Scholar won't index? If your software is consistently cited---e.g., Eenoku (2019) Library, http://url.com---then surely Google will index that.
– user2768
17 hours ago
@Eenoku Are you sure that Google Scholar won't index? If your software is consistently cited---e.g., Eenoku (2019) Library, http://url.com---then surely Google will index that.
– user2768
17 hours ago
1
1
You may be wrong. Google Scholar reports that a subset of my lecture notes, which is only published as PDFs on my web page, has 5 citations.
– JeffE
15 hours ago
You may be wrong. Google Scholar reports that a subset of my lecture notes, which is only published as PDFs on my web page, has 5 citations.
– JeffE
15 hours ago
add a comment |
4 Answers
4
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 yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
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
yesterday
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
yesterday
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
yesterday
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.
yesterday
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
19 hours ago
|
show 3 more comments
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 yesterday
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
yesterday
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
yesterday
add a comment |
In addition to the above answers, you can publish a short article about the software at the Journal of open Source Software (JOSS). How this journal differs from other journals is described in its announcement post.
Your submitted article and the associated software are thoroughly peer reviewed. If the article is accepted, it will be assigned a volume number, official DOI, etc. In effect, you have a "real" article that can be cited just like a "regular" journal article. This is separate from obtaining a DOI just for your software through services such as Zenodo and figshare, which are mainly intended for archival storage of software and datasets.
answered 19 hours ago
mtallmtall
22915
Having published in JOSS, their review process is very interesting (based almost solely around the software itself, done publicly on github, meant to improve the software and ensure its ready for production with adequate documentation) and leads to very quick turnaround times depending on how quickly you address reviewer concerns. Submission to publication took 10 days for me. Their requirements for the manuscript itself are minimal.
– Jared Andrews
13 hours ago
add a comment |
Concerning the DOI / citable discussion, see DOI != citable
And if your using Zenodo to create a DOI, as @Wolfgang Bangerth mentioned, see Making Your Code Citable.
Basically here you have to decide how you will make your library publicly available. There are different ways to do it but the links describes how to connect Zenodo with GitHub. This may also depend on whether you want to allow citing different versions of your library or just "link to releases" on you institute's webpage.
Here you will find more input for the discussion How to cite and describe software.
They're showing recommendations from software providers, which is a simple as creating your own BibTeX entry with an url.
However, the next section shows different positions of "Software is not a citable output". Keep that in mind when providing a special way to cite your library.
answered 13 hours ago
amkaamka
1
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
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
4 Answers
4
active
oldest
votes
4 Answers
4
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 yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
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
yesterday
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
yesterday
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
yesterday
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.
yesterday
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
19 hours ago
|
show 3 more comments
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 yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
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
yesterday
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
yesterday
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
yesterday
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.
yesterday
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
19 hours ago
|
show 3 more comments
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 yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
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 yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
answered yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
answered yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
answered yesterday
Wolfgang BangerthWolfgang Bangerth
35.1k470123
35.1k470123
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
yesterday
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
yesterday
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
yesterday
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.
yesterday
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
19 hours ago
|
show 3 more comments
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
yesterday
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
yesterday
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
yesterday
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.
yesterday
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
19 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
yesterday
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
yesterday
1
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
yesterday
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
yesterday
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
yesterday
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
yesterday
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.
yesterday
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.
yesterday
3
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
19 hours ago
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
19 hours ago
|
show 3 more comments
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 yesterday
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
yesterday
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
yesterday
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 yesterday
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
yesterday
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
yesterday
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 yesterday
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 yesterday
user2768user2768
14.9k33859
answered yesterday
user2768user2768
14.9k33859
answered yesterday
user2768user2768
14.9k33859
answered yesterday
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
yesterday
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
yesterday
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
yesterday
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
yesterday
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
yesterday
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
yesterday
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
yesterday
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
yesterday
add a comment |
In addition to the above answers, you can publish a short article about the software at the Journal of open Source Software (JOSS). How this journal differs from other journals is described in its announcement post.
Your submitted article and the associated software are thoroughly peer reviewed. If the article is accepted, it will be assigned a volume number, official DOI, etc. In effect, you have a "real" article that can be cited just like a "regular" journal article. This is separate from obtaining a DOI just for your software through services such as Zenodo and figshare, which are mainly intended for archival storage of software and datasets.
answered 19 hours ago
mtallmtall
22915
Having published in JOSS, their review process is very interesting (based almost solely around the software itself, done publicly on github, meant to improve the software and ensure its ready for production with adequate documentation) and leads to very quick turnaround times depending on how quickly you address reviewer concerns. Submission to publication took 10 days for me. Their requirements for the manuscript itself are minimal.
– Jared Andrews
13 hours ago
add a comment |
In addition to the above answers, you can publish a short article about the software at the Journal of open Source Software (JOSS). How this journal differs from other journals is described in its announcement post.
Your submitted article and the associated software are thoroughly peer reviewed. If the article is accepted, it will be assigned a volume number, official DOI, etc. In effect, you have a "real" article that can be cited just like a "regular" journal article. This is separate from obtaining a DOI just for your software through services such as Zenodo and figshare, which are mainly intended for archival storage of software and datasets.
answered 19 hours ago
mtallmtall
22915
Having published in JOSS, their review process is very interesting (based almost solely around the software itself, done publicly on github, meant to improve the software and ensure its ready for production with adequate documentation) and leads to very quick turnaround times depending on how quickly you address reviewer concerns. Submission to publication took 10 days for me. Their requirements for the manuscript itself are minimal.
– Jared Andrews
13 hours ago
add a comment |
In addition to the above answers, you can publish a short article about the software at the Journal of open Source Software (JOSS). How this journal differs from other journals is described in its announcement post.
Your submitted article and the associated software are thoroughly peer reviewed. If the article is accepted, it will be assigned a volume number, official DOI, etc. In effect, you have a "real" article that can be cited just like a "regular" journal article. This is separate from obtaining a DOI just for your software through services such as Zenodo and figshare, which are mainly intended for archival storage of software and datasets.
answered 19 hours ago
mtallmtall
22915
In addition to the above answers, you can publish a short article about the software at the Journal of open Source Software (JOSS). How this journal differs from other journals is described in its announcement post.
Your submitted article and the associated software are thoroughly peer reviewed. If the article is accepted, it will be assigned a volume number, official DOI, etc. In effect, you have a "real" article that can be cited just like a "regular" journal article. This is separate from obtaining a DOI just for your software through services such as Zenodo and figshare, which are mainly intended for archival storage of software and datasets.
answered 19 hours ago
mtallmtall
22915
answered 19 hours ago
mtallmtall
22915
answered 19 hours ago
mtallmtall
22915
answered 19 hours ago
mtallmtall
22915
22915
Having published in JOSS, their review process is very interesting (based almost solely around the software itself, done publicly on github, meant to improve the software and ensure its ready for production with adequate documentation) and leads to very quick turnaround times depending on how quickly you address reviewer concerns. Submission to publication took 10 days for me. Their requirements for the manuscript itself are minimal.
– Jared Andrews
13 hours ago
add a comment |
Having published in JOSS, their review process is very interesting (based almost solely around the software itself, done publicly on github, meant to improve the software and ensure its ready for production with adequate documentation) and leads to very quick turnaround times depending on how quickly you address reviewer concerns. Submission to publication took 10 days for me. Their requirements for the manuscript itself are minimal.
– Jared Andrews
13 hours ago
Having published in JOSS, their review process is very interesting (based almost solely around the software itself, done publicly on github, meant to improve the software and ensure its ready for production with adequate documentation) and leads to very quick turnaround times depending on how quickly you address reviewer concerns. Submission to publication took 10 days for me. Their requirements for the manuscript itself are minimal.
– Jared Andrews
13 hours ago
Having published in JOSS, their review process is very interesting (based almost solely around the software itself, done publicly on github, meant to improve the software and ensure its ready for production with adequate documentation) and leads to very quick turnaround times depending on how quickly you address reviewer concerns. Submission to publication took 10 days for me. Their requirements for the manuscript itself are minimal.
– Jared Andrews
13 hours ago
add a comment |
Concerning the DOI / citable discussion, see DOI != citable
And if your using Zenodo to create a DOI, as @Wolfgang Bangerth mentioned, see Making Your Code Citable.
Basically here you have to decide how you will make your library publicly available. There are different ways to do it but the links describes how to connect Zenodo with GitHub. This may also depend on whether you want to allow citing different versions of your library or just "link to releases" on you institute's webpage.
Here you will find more input for the discussion How to cite and describe software.
They're showing recommendations from software providers, which is a simple as creating your own BibTeX entry with an url.
However, the next section shows different positions of "Software is not a citable output". Keep that in mind when providing a special way to cite your library.
answered 13 hours ago
amkaamka
1
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
add a comment |
Concerning the DOI / citable discussion, see DOI != citable
And if your using Zenodo to create a DOI, as @Wolfgang Bangerth mentioned, see Making Your Code Citable.
Basically here you have to decide how you will make your library publicly available. There are different ways to do it but the links describes how to connect Zenodo with GitHub. This may also depend on whether you want to allow citing different versions of your library or just "link to releases" on you institute's webpage.
Here you will find more input for the discussion How to cite and describe software.
They're showing recommendations from software providers, which is a simple as creating your own BibTeX entry with an url.
However, the next section shows different positions of "Software is not a citable output". Keep that in mind when providing a special way to cite your library.
answered 13 hours ago
amkaamka
1
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
add a comment |
Concerning the DOI / citable discussion, see DOI != citable
And if your using Zenodo to create a DOI, as @Wolfgang Bangerth mentioned, see Making Your Code Citable.
Basically here you have to decide how you will make your library publicly available. There are different ways to do it but the links describes how to connect Zenodo with GitHub. This may also depend on whether you want to allow citing different versions of your library or just "link to releases" on you institute's webpage.
Here you will find more input for the discussion How to cite and describe software.
They're showing recommendations from software providers, which is a simple as creating your own BibTeX entry with an url.
However, the next section shows different positions of "Software is not a citable output". Keep that in mind when providing a special way to cite your library.
answered 13 hours ago
amkaamka
1
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
Concerning the DOI / citable discussion, see DOI != citable
And if your using Zenodo to create a DOI, as @Wolfgang Bangerth mentioned, see Making Your Code Citable.
Basically here you have to decide how you will make your library publicly available. There are different ways to do it but the links describes how to connect Zenodo with GitHub. This may also depend on whether you want to allow citing different versions of your library or just "link to releases" on you institute's webpage.
Here you will find more input for the discussion How to cite and describe software.
They're showing recommendations from software providers, which is a simple as creating your own BibTeX entry with an url.
However, the next section shows different positions of "Software is not a citable output". Keep that in mind when providing a special way to cite your library.
answered 13 hours ago
amkaamka
1
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
answered 13 hours ago
amkaamka
1
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
answered 13 hours ago
amkaamka
1
answered 13 hours ago
amkaamka
1
1
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
New contributor
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
amka is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
add a comment |
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
3
I don't understand the question. Your software is already citable, by listing your name, the name of the library, and the URL.
– JeffE
19 hours ago
@JeffE That's the truth, but it's not going to be indexed anywhere, not even Google Scholar, if I'll have just the name and URL...
– Eenoku
18 hours ago
1
@Eenoku Are you sure that Google Scholar won't index? If your software is consistently cited---e.g., Eenoku (2019) Library, http://url.com---then surely Google will index that.
– user2768
17 hours ago
1
You may be wrong. Google Scholar reports that a subset of my lecture notes, which is only published as PDFs on my web page, has 5 citations.
– JeffE
15 hours ago