Publishing from Code Ocean Private Cloud to Public Code Ocean

Overview

The Code Ocean Private Cloud is a private deployment of Code Ocean that is separate from the public Code Ocean platform (codeocean.com). There is a way to publish capsules created on your private Code Ocean deployment to the public platform so it can be publicly available.

Prerequisites

  • Ensure that the capsule does not contain any sensitive information

  • All the data can be made publicly available

  • Contact Code Ocean support if the capsule uses datasets exceeding 10GB, to make these datasets publicly available

Follow these publication steps:

  1. Release your capsule By releasing the capsule on the private deployment it is ensured that it’s fully reproducible and immutable

  2. Export the release capsule

    • Click Export in the capsule menu

    • Select Include data

    • Click Export

    • Unzip the file when the download is complete

    • Delete REPRODUCING.md from the extracted capsule

  3. Create a user on codeocean.com If it’s the first time you are using the public platform, sign up for a free Code Ocean account at https://codeocean.com/signup

  4. Create an identical private capsule on the public codeocean.com platform.

    • Upload all the contents of the extracted capsule into the newly created capsule

  5. Recreate the capsule environment Notice that no starter environment is selected in the capsule's environment

    • Click Change

    • Select a starter environment that matches the original capsule

    • Configure all packages and package manager in exactly the same manner as the original

  6. Run the capsule and check the results against the original capsule results.

  7. Complete the capsule metadata in order to publish it

    • Navigate to the capsule metadata

    • Complete the required information

    • Select a theme image for the capsule, this is used as an image thumbnail in the explore and search pages.

  8. Click Commit in the capsule timeline to commit pending changes

  9. Click Submit for publication in the capsule timeline. Review the checklist and final steps.

  10. Click Submit

  11. Await publication The capsule is waiting for verification by our verification team. Once complete, the capsule is published. This will take a few days. You are welcome to contact us if you need it done earlier. You will be notified by email once your capsule is published.