Code Ocean for Cambridge Elements
Product Specifications
- Product Name: Code Ocean for Cambridge Elements
- Functionality: Platform for authors to publish and share code associated with their research
- Accessibility: No software download is required, code can be viewed and interacted with online
INSTRUCTION
What is Code Ocean?
CodeOcean is a platform that enables authors to publish code and data files associated with their research under open licensing. Where it differs from a data repository – like Dataverse, Dryad or Zenodo – is that Code Ocean
also enables readers to run and manipulate the code without downloading any software, as well as download and share it. It’s therefore a useful tool for engaging readers with code, as well as a way for authors to transparently demonstrate that the results presented in their article can be reproduced.
Code Ocean allows authors to publish the code associated with their research, making it citable and available on a platform that encourages users to interact with the code. An interactive window containing the code can be embedded in the author’s HTML publication on Cambridge Core
It enables readers, including those who are not code experts, to interact with code – run the code and view the outputs, edit the code and change parameters, download and share the code – within their browser, without having to install software.
Reader note: The Code Ocean code above contains the code to replicate the results of this Element. You con run the code and view the outputs, but to do so you will need to sign on to the Code Oceon site (or log in if you have an existing Code Ocean account).
How the Code Ocean capsule will look to the reader.
Uploading and Publishing Code on Code Ocean
- The best resource for authors getting started with Code Ocean is the Help guide, which contains text and video support for authors: https://help.codeocean.com/getting-started. There s also a live chat function.
- To upload and publish code, an author needs to have registered for a Code Ocean account (consisting of a name/email/password).
- Once logged in, an author can upload code by creating a new compute ‘capsule’ in the relevant software language.
After an author clicks publish ™ on Code Ocean, the code is not published straight away “There is a verification step, performed by the Code Ocean author support staff. Code Ocean works with authors to ensure that:
- The capsule is self-contained, with all necessary code and data to make it understandable (i.e. no obvious files missing)
- There are no extraneous files or dependencies
- The details (name, description, image) are clear and reflect the code’s functionality
Code Ocean may be in touch with the author directly with any queries, but you can expect the code to publish within a couple of days of submission.
Submitting your Code Ocean files to Cambridge
Include a placeholder statement in your manuscript confirming where the capsule should appear in the HTML, e.g. <INSERT CODE OCEAN CAPSULE HERE>, or provide clear written instructions on the placement directly to your Content Manager.
Provide a data availability statement at the end of your Element including the DOIs for each capsule included with this publication.
Send your Content Manager the DOIs and URL link to the capsules.
The DOI is located on the metadata tab:
The link to the capsule can be found by clicking on the share capsule button on the top right of the screen:
Which brings up the pop-up screen including the capsule link:
Your Content Manager will require both to be able to add the capsule into the HTML of your Element.
If you have any queries, please contact your Content Manager. www.cambridge.org/core/what-we-publish/elements
Frequently Asked Questions
- Q: What is Code Ocean?
- A: Code Ocean is a platform that allows authors to publish and share code associated with their research without the need for downloading any software. It enables transparency in research results by making code citable and interactable.
- Q: How long does it take for the submitted code to be published on Code Ocean?
- A: Authors can expect their submitted code to be published within a couple of days after submission.
Documents / Resources
 |
Code Ocean Code Ocean for Cambridge Elements [pdf] Instruction Manual Code Ocean for Cambridge Elements, for Cambridge Elements, Cambridge Elements, Elements |
