Code4REF

How to record research software in CRIS (Current Research Information Systems)


How to report software outputs in Pure

This guide has been written with reference to the Pure instance at the University of St Andrews, which is version 5.13.1 at the time of writing.

Create a new Research Output from template Non-textual form->Software

Image

Then you will see the following input form:

Image

Enter details for Publication status and dates. Published and Unpublished are likely to be the relevant options, with Published being appropriate for open-source software.

Image

Enter the publication information. Note that the mandatory Original language field does not refer to programming languages.

Image

Leave Media of output as No value, or specify Online for software publicly available for downloads.

Image

Add Contributors. Here you can search and add an internal contributor by their nbame, or create an external person.

Image

After choosing an internal collaborator, you will see the next window.

Image

The list of roles here is not really suitable for software projects (this is something to ask Pure developers in the future), so for now Author is likely the most useful role. There is no suitable role for maintainers, testers and other contributors who are not authors - for these, you should use Other.

Image

After adding a new author, you will see the extended list of authors:

Image

Change the Managing organisational unit if necessary.

Add Publisher information.

Image

Potentially relevant options such as GitHub and Zenodo may already be available, or they can be created. If the software is available from its webpage, but not published via some repository, you can leave this field blank.

Image

The next section, Electronic version(s), and related files and links, is where you can link to an external resource and/or upload files. In particular, if you have a DOI you should add it here, along with details of the applicable license.

For example, below is what is used for the release of the GAP system, version 4.10.1:

Image

This is a link to the downloads page for the official GAP distribution:

Image

This is a link to the corresponding tag in the GAP repository on GitHub:

Image

If adding any keywords, try and be consistent with what you have used elsewhere (e.g. on GitHub) but try and avoid creating new keywords unnecessarily.

Add details of any Relations the record has to any existing records in Pure

  • Research Outputs (papers), Activities, Projects, Datasets etc.

Image

Finally, set the Visibility according to how you wish the record to be available and press Save.