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
What connection does MS Office have to Netscape Navigator?
Some questions about different axiomatic systems for neighbourhoods
Running a General Election and the European Elections together
I believe this to be a fraud - hired, then asked to cash check and send cash as Bitcoin
A Man With a Stainless Steel Endoskeleton (like The Terminator) Fighting Cloaked Aliens Only He Can See
Why isn't acceleration always zero whenever velocity is zero, such as the moment a ball bounces off a wall?
Why don't programming languages automatically manage the synchronous/asynchronous problem?
Won the lottery - how do I keep the money?
Does increasing your ability score affect your main stat?
Flying from Cape Town to England and return to another province
How a 64-bit process virtual address space is divided in Linux?
Is it ever safe to open a suspicious HTML file (e.g. email attachment)?
Why does standard notation not preserve intervals (visually)
Newlines in BSD sed vs gsed
Find non-case sensitive string in a mixed list of elements?
Does Germany produce more waste than the US?
Why is information "lost" when it got into a black hole?
WOW air has ceased operation, can I get my tickets refunded?
Domestic-to-international connection at Orlando (MCO)
Which one is the true statement?
Is it professional to write unrelated content in an almost-empty email?
Is it convenient to ask the journal's editor for two additional days to complete a review?
Can we say or write : "No, it'sn't"?
What steps are necessary to read a Modern SSD in Medieval Europe?
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 2 days ago
Massimo Ortolano
39.5k12119149
asked 2 days ago
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 2 days ago
Massimo Ortolano
39.5k12119149
asked 2 days ago
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
yesterday
@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
yesterday
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
yesterday
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
yesterday
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 2 days ago
Massimo Ortolano
39.5k12119149
asked 2 days ago
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 2 days ago
Massimo Ortolano
39.5k12119149
asked 2 days ago
EenokuEenoku
1,12421020
edited 2 days ago
Massimo Ortolano
39.5k12119149
asked 2 days ago
EenokuEenoku
1,12421020
edited 2 days ago
Massimo Ortolano
39.5k12119149
edited 2 days ago
Massimo Ortolano
39.5k12119149
edited 2 days ago
Massimo Ortolano
39.5k12119149
39.5k12119149
asked 2 days ago
EenokuEenoku
1,12421020
asked 2 days ago
EenokuEenoku
1,12421020
asked 2 days ago
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
yesterday
@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
yesterday
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
yesterday
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
yesterday
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
yesterday
@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
yesterday
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
yesterday
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
yesterday
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
yesterday
I don't understand the question. Your software is already citable, by listing your name, the name of the library, and the URL.
– JeffE
yesterday
@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
yesterday
@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
yesterday
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
yesterday
@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
yesterday
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
yesterday
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
yesterday
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 2 days ago
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
2 days ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
2 days 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
2 days 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.
2 days ago
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
yesterday
|
show 4 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 2 days 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
2 days 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
2 days 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 yesterday
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
yesterday
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 yesterday
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 2 days ago
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
2 days ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
2 days 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
2 days 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.
2 days ago
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
yesterday
|
show 4 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 2 days ago
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
2 days ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
2 days 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
2 days 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.
2 days ago
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
yesterday
|
show 4 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 2 days ago
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 2 days ago
Wolfgang BangerthWolfgang Bangerth
35.1k470123
answered 2 days ago
Wolfgang BangerthWolfgang Bangerth
35.1k470123
answered 2 days ago
Wolfgang BangerthWolfgang Bangerth
35.1k470123
answered 2 days ago
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
2 days ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
2 days 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
2 days 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.
2 days ago
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
yesterday
|
show 4 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
2 days ago
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
2 days 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
2 days 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.
2 days ago
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
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
2 days 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
2 days ago
1
1
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
2 days ago
You will probably want to take a look here: toms.acm.org/authors.cfm
– Wolfgang Bangerth
2 days 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
2 days 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
2 days 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.
2 days 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.
2 days ago
3
3
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
yesterday
Neither a DOI nor an explanatory research paper is actually necessary for something to be citable.
– JeffE
yesterday
|
show 4 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 2 days 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
2 days 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
2 days 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 2 days 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
2 days 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
2 days 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 2 days 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 2 days ago
user2768user2768
14.9k33859
answered 2 days ago
user2768user2768
14.9k33859
answered 2 days ago
user2768user2768
14.9k33859
answered 2 days 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
2 days 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
2 days 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
2 days 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
2 days 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
2 days 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
2 days 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
2 days 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
2 days 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 yesterday
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
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 yesterday
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
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 yesterday
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 yesterday
mtallmtall
22915
answered yesterday
mtallmtall
22915
answered yesterday
mtallmtall
22915
answered yesterday
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
yesterday
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
yesterday
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
yesterday
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
yesterday
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 yesterday
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 yesterday
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 yesterday
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 yesterday
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 yesterday
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 yesterday
amkaamka
1
answered yesterday
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
yesterday
@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
yesterday
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
yesterday
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
yesterday