Instructions for Code Ocean submissions

Author: Parth Paritosh

Please see code ocean website here: https://codeocean.com/

This website allows you to publish code that can be executed by anyone on the website without doing any setup.

Environment setup

1. Choose appropriate environment from the list of Python, R, Stata, MATLAB etc.
2. Select the necessary libraries corresponding to each package manager. For bash-Python environment, this includes apt-get, conda, pip.
3. A post-script file can be added to download, extract and install custom libraries.

This information will be populated to the docker file

Metadata

1. Include the title of your research article (or another informative title).
2. Mark relevant research field tags and author list.
3. Indicate publication status and journal/conference information.
4. Choose license: MIT > Apache > BSD in the order of ease of distribution. MIT license is the default for enhancing distribution.

Code, data and results

1. Add your code files to the Code folder
2. The data goes the data folder at the same level
3. The results are published to results folder.

In the code, all results and data should be saved to ../results/ or ../data/ folder.

Readme

Update readme file to indicate the use of each function and data. You can mention any interpretation of figures, link to Github, and link to other relevant work. See example: https://codeocean.com/capsule/7376063/tree

Reproducible run

The run file in the Code folder contains the bash script used during Reproducible run.

Please indicate the first file to be run at this step.

python -u mainfilename.py "$@"

See more instructions here:

https://help.codeocean.com/en/articles/1120151-code-ocean-s-verification-process-for-computational-reproducibility-quality

Best of luck!