Getting Started

Covering: 1) what is a compute capsule 2) uploading code and data 3) configuring your environment, 4) publishing on Code Ocean.

12 articles in this collection
Written by Shahar Zaks

What is a compute capsule?

Code + (optional) data + computational environment = the minimum required for computational reproducibility.

Written by Shahar Zaks
Updated over a week ago

Uploading code and data

How do I upload my code to Code Ocean?

Uploading to Code Ocean for new users.

Written by Shahar Zaks
Updated over a week ago

Paths

/code, /data, /results, and symbolic links.

Written by Shahar Zaks
Updated over a week ago

Saving files

Files must be saved explicitly to the /results folder.

Written by Shahar Zaks
Updated over a week ago

Using public datasets

Take advantage of preloaded public datasets, or upload your own.

Written by Shahar Zaks
Updated over a week ago

What is, and is not, a good fit for publishing and sharing on Code Ocean?

Pipelines, analyses, visualizations, and statistical checks are all great fits for publishing on Code Ocean.

Written by Shahar Zaks
Updated over a week ago

The computational environment

Configuring your computational environment: an overview

Where to begin, and what steps to take next.

Written by Shahar Zaks
Updated over a week ago

Selecting a base environment

Choose from among a curated collection of runtime environments covering common languages and frameworks.

Written by Shahar Zaks
Updated over a week ago

The package management system

Install any libraries, packages, or dependencies your code needs in order to run.

Written by Shahar Zaks
Updated over a week ago

Using the postInstall script for further customization

Download, extract, compile – use the full set of tools available on Linux to set up your runtime environment.

Written by Shahar Zaks
Updated over a week ago

Monitoring and inspecting the result of the environment setup phase

The "buildLog" result file contains the console output from package installation commands and postInstall execution.

Written by Shahar Zaks
Updated over a week ago

Setting up new or additional languages on Code Ocean via the package managers

How to use the package management system and postInstall script to install languages, interpreters, and compilers.

Written by Shahar Zaks
Updated over a week ago