Publishing software

Revision as of 00:29, 12 December 2019 by (talk | contribs)

You can now publish the code you used for your research with the new CLEx software community on Zenodo. More publishers are now requiring code to be published along side data. We hope the Zenodo community will also served as a way to share our codes in a user friendly way. So even if you are not require to publish your code you can see this collection as an opportunity to share your work with others. Zenodo is an initiative funded by CERN that allows anyone to share their research outputs and attach to them a DOI. In the future there might be other options to publish software, including with NCI, at the moment Zenodo offers a FAIR ( Findable Accessible Interoperable Reusable) solution to the lack of dedicated services.  

How to publish

Publishing is currently very easy depending on how much your code is already organised.

  1. if you don't have one already create a public repository, usually github is the preferred choice
  2. add a comprehensive ReadMe file to your repository. make sure that the ReadMe file covers what the code does, how is organised (if you have more than one file) and some basic information on its usage.
  3. Once you are ready to publish you can create a release. Basically add a version label to a particular commit of your code. This step is optional but it's a good idea to do it if you think you might have different version in the future and if you expect others to use your code as well.
  4. Let us know that you want to publish via the helpdesk, if your ReadMe file is well documented, it might take as little as 20 minutes for us to add  your repository to the Zenodo community.  


The only requirement currently is for your description of the code to be reasonable comprehensive, we are not checking the quality of your code. if you like some advice and feedback on a code you would like to share more widely though we are happy to help you. As usual you can contact us via the CWS helpdesk.