11

Basically, I have written a tutorial for a code which performs a specific type of electronic-structure calculation. The code has been developed by the group I belong to and writing this tutorial/manual is part of our efforts towards achieving greater visibility and getting people to use the code.

I have put in sections on the underlying theory, some technical details, usage guidelines, and some examples of actual calculations that can be done with the code. As such, there is no original scientific contribution, since we already published the new scientific bits pertaining to the implementation in another paper. However the document is a (rigorous) scientific and technical document.

I have seen manuals uploaded on the arXiv before, but I do not know if this fits the arXiv's purpose. Hence, I was wondering whether it is appropriate/a good idea to upload my tutorial to the arXiv.

(Note: I have been browsing the arXiv help but have not found anything on this. Let me know if I have missed any policies stated somewhere on their website.)

8

If your manual is specific to your group's environment (software, lab, equipment, protocols, etc.), then I would consider posting such document on arXiv as not appropriate. A better place for such documents IMHO would be figshare or Zenodo. Both services allow artifacts to be not only citable, but also discoverable (via DOI assignment). Version control is supported as well, but the advantage of Zenodo in this regard in comparison with figshare is Git and GitHub integration.

If, on the other hand, the document is not specific to your group's or other particular environment (or, perhaps, you want to share this document as a model of how such documents should be structured, presented and what content should they contain), then I agree with other answers in that it is totally appropriate to post such document on arXiv.

|improve this answer|||||
  • 1
    Very interesting alternatives, thanks for the suggestion. – Miguel May 20 '15 at 13:54
  • 1
    I decided to put the manual on Zenodo, it looks like a better fit than arXiv. Thanks again. – Miguel May 20 '15 at 20:28
  • @Miguel: My pleasure. I'm glad I was able to help. – Aleksandr Blekh May 21 '15 at 0:28
4

Yes, this seems like a totally appropriate use of the arXiv. If you hope that other people will use your code, then the documentation has to be available online. While you will presumably have the documentation available alongside the code (wherever you are making the latter available), putting the documentation on the arXiv as well will certainly make more people aware of the tools you have created.

As you say, the documentation for some scientific analysis programs are already available on the arXiv. These files form a very small subset of the total arXiv, but they are valuable. Once or twice I have looked at the documentation for analysis programs on the arXiv, even though I was not using (or even considering using) the software packages myself; I looked up the documentation because it helped me understand other people's papers that did use these tools.

|improve this answer|||||
0

In addition to the arXiv, which I do believe would be appropriate for this purpose, there is a journal called Computer Physics Communications that you might even get this published in.

|improve this answer|||||

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.