Difference between revisions of "Publishing software"

Line 5: Line 5:
  
 
We will curate the Collection for the duration of CLEX, but the records will be still available and visible well past CLEX termination.
 
We will curate the Collection for the duration of CLEX, but the records will be still available and visible well past CLEX termination.
 +
  
 
=== '''How to publish''' ===
 
=== '''How to publish''' ===
  
Publishing is currently very easy depending on how much your code is already organised.
+
Publishing your code is easy and quick as long as your code is already organised and has a resonable description.
 
 
 
 
  
#Create a zenodo account, you can use your orcid to login if you have one  
+
#Create a zenodo account, you can use your ORCID to login if you have one.
 
#Create a zenodo record for your code, uploading the relevant files.  
 
#Create a zenodo record for your code, uploading the relevant files.  
 
#*Provide a comprehensive description, this should cover what the code does, how is organised (if you have more than one file) and some basic information on its usage.  
 
#*Provide a comprehensive description, this should cover what the code does, how is organised (if you have more than one file) and some basic information on its usage.  
#*Add to your record meanfigul keywords and any relevant link.  
+
#*Add to your record meaningful keywords and any relevant link.  
 
#*Choose the CLEX Code Collection as community. Your code can be listed in more than one community.   
 
#*Choose the CLEX Code Collection as community. Your code can be listed in more than one community.   
#*Having your code on a version control repository (and possibly github) is highly reccommended but it is not a requirement to publish on Zenodo, you can still publish your code without one.  
+
#*Having your code on a version control repository (and possibly github) is highly recommended but it is not a requirement to publish on Zenodo, you can still publish your code without one.  
#*If you have your code in a github repository you can give zenodo access to your repository and everytime you create a new release you zenodo record will be updated. <link>  
+
#*If you have your code in a github repository you can give zenodo access to your repository and every time you create a new release you zenodo record will be updated automatically. <link>  
#*Everytime you change files you&nbsp;have to create a new version of the record and a new doi will be minted. Any other field can be updated at any time without need for the record to be republished.   
+
#*Every time you change files you&nbsp;have to create a new version of the record and a new DOI&nbsp;will be minted. Any other field can be updated at any time without need for the record to be republished.   
#We will receive your request and check that you code is well described and in line with the Collection policies.  
+
#We will receive your request to join the CCC&nbsp;and check that you code is well described and in line with the Collection policies.  
 
#If you do not want to create your own Zenodo account we can create a record for you*. In that case, let us know that you want to publish via the helpdesk.&nbsp;If your code is well documented, it might take as little as 20 minutes for us to add&nbsp;&nbsp;your repository to the Zenodo community. &nbsp;  
 
#If you do not want to create your own Zenodo account we can create a record for you*. In that case, let us know that you want to publish via the helpdesk.&nbsp;If your code is well documented, it might take as little as 20 minutes for us to add&nbsp;&nbsp;your repository to the Zenodo community. &nbsp;  
  
* Please note that having your own zenodo account will give you more control on your code and it is especially reccomended if you are likely to release new versions in the future, as we might not be able to set up automatic&nbsp;updates if the owner of the zenodo recod is different from the github repository owner.
+
*Please note that having your own zenodo account will give you more control on your code and it is especially recommended if you are likely to release new versions in the future, as we might not be able to set up automatic&nbsp;updates if the owner of the zenodo record is different from the github repository owner.
  
 
=== '''Requirements''' ===
 
=== '''Requirements''' ===

Revision as of 23:16, 19 April 2021

Template:Working on New page under construction

You can now publish the code you used for your research with the new CLEX Code Collection 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 required 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. Zenodo is funded for at least the next 20 years and so it offers a good long term solution, as well as been widely used internationally.

We will curate the Collection for the duration of CLEX, but the records will be still available and visible well past CLEX termination.


How to publish

Publishing your code is easy and quick as long as your code is already organised and has a resonable description.

  1. Create a zenodo account, you can use your ORCID to login if you have one.
  2. Create a zenodo record for your code, uploading the relevant files.
    • Provide a comprehensive description, this should cover what the code does, how is organised (if you have more than one file) and some basic information on its usage.
    • Add to your record meaningful keywords and any relevant link.
    • Choose the CLEX Code Collection as community. Your code can be listed in more than one community. 
    • Having your code on a version control repository (and possibly github) is highly recommended but it is not a requirement to publish on Zenodo, you can still publish your code without one.
    • If you have your code in a github repository you can give zenodo access to your repository and every time you create a new release you zenodo record will be updated automatically. <link>
    • Every time you change files you have to create a new version of the record and a new DOI will be minted. Any other field can be updated at any time without need for the record to be republished.
  3. We will receive your request to join the CCC and check that you code is well described and in line with the Collection policies.
  4. If you do not want to create your own Zenodo account we can create a record for you*. In that case, let us know that you want to publish via the helpdesk. If your code is well documented, it might take as little as 20 minutes for us to add  your repository to the Zenodo community.  
  • Please note that having your own zenodo account will give you more control on your code and it is especially recommended if you are likely to release new versions in the future, as we might not be able to set up automatic updates if the owner of the zenodo record is different from the github repository owner.

Requirements

We set up policies covering the use and contribution to the Collection.

 

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.