Release Notes 3.1 (January 2025)

Public Collections

Public Collections extends the existing Code Ocean Collections functionality to allow administrators to create specific publicly accessible collections. This enables greater visibility and collaboration, making it easier to showcase your work to the wider community.

Public Collections is a paid product. Please reach out to your Customer Success Manager for clarification.

Markdown Support in Descriptions

We've extended the ability to create and view descriptions in Markdown across more areas of the platform. Now, users can use Markdown formatting in Capsule, Pipeline, Data, and Model descriptions, allowing for richer, more flexible content formatting.

Enhanced Filtering

We've introduced new filters across several key areas, further extending the new filtering capabilities from the dashboards to other parts of the system. This update helps users find their assets more efficiently by providing advanced filtering options in the following areas:

• Attach/Detach Data panel

• Adding Capsules and Data to Pipelines

• Pipelines UI Replace

• App Panel Replace

• Managing Assets in Collections

Automatic VS Code Extension Installation

The VS Code Cloud Workstation now comes with pre-installed extensions to optimize your development experience. These extensions enhance productivity by supporting Python, R, and Jupyter workflows, providing syntax highlighting, and enabling AI-assisted coding with Claude and Continue.

The following extensions will be installed with their latest versions:

• Python: python.python@2024.20.0

• R Support: REditorSupport.R@2.8.4

• Jupyter: ms-toolsai.jupyter@2024.10.0

• BioSyntax: reageyao.bioSyntax@0.0.11

• Claude Dev: saoudrizwan.claude-dev@2.1.6

• Continue: continue.continue@0.9.231

Admin Enhancements

Maintenance Mode

Administrators can enable Maintenance Mode directly from the Admin Panel. Once enabled, the system will automate several steps that were previously done manually, including:

• Cancelling running computations

• Stopping background Async jobs

• Cancelling AWS Batch jobs

Additionally, users will be unable to access the system while Maintenance Mode is enabled, ensuring a safer and more streamlined upgrade process.

Invite New Users — Copy All, Persistent Invite Links

When manually adding new users to Code Ocean, it's now possible to copy all of the invite links that are generated with one click.

Additionally, if you close this invite window, the invite links will persist and be available the next time you click Invite New Users. Click Reset to remove the previous email addresses and links.

API Enhancements and Updates

There are several additions and changes to the public API in Code Ocean version 3.1. You can view the full API documentation here.

Code Ocean Python SDK v0.3.0

v0.3.0 of the Code Ocean Python SDK has been released! Our pip-installable SDK provides convenient access to the Code Ocean API from applications written in the Python language, enabling you to manage Code Ocean resources such as Capsules, Data Assets, and Computations in your Python applications. All of the API updates below are also supported by the SDK.

Get Capsule — Updated Fields

Some of the fields in the Get Capsule API have been renamed to reflect current system terminology.

• published_capsule --> release_capsule

• keywords --> tags

• version.publish_time --> version.release_time

Note, this will require updates to existing scripts that utilize the Get Capsule API.

Improved Pagination Support

The Code Ocean Data Asset and Capsule public API search endpoints, previously limited to returning 10,000 results, now support searching for an unlimited number of assets.

When a query returns more results than can be included in a single response, the response includes a next_token field that can be used in subsequent queries to retrieve the next page of results.

Search Data Assets Response Example

{

'has_more': True/False, (indicates whether there are more results)

'next_token': 'sometoken',

'results': [Data Asset Object]

}

Change Location of Data Asset

The location of Data Assets can be changed via the API while maintaining lineage and provenance. You can use this feature to change the S3 location of an External Data Asset, or to make an Internal Data Asset an External Data Asset.

Transfer Data Asset

curl -X POST 'http://{codeocean-domain}/api/v1/data_assets/{data_asset_id}/transfer' \
-u cop_d23dasd312: \
-H 'Content-Type: application/json' \
--data-raw '{
  "target": {
    "aws": {
      "bucket": "MY_BUCKET",
      "prefix": "PREFIX"
    }
  }
}'

When transferring files from an External Data Asset linked to a public S3 bucket, the S3 bucket should have ACLs disabled as described here.

Capsule Search

It's now possible to search Capsules via the public API in the same way you are able to search Data Assets.

Capsule Search

curl -H "Content-Type: application/json" -u ${CUSTOM_KEY}: -X POST https://${co_domain}/api/v1/capsules/search --data-raw '{
"from": 0,
"limit": 2,
"sort_order": "desc",
"sort_field": "name",
"query": "name:my_capsule tag:my_tag",
"ownership": "created",
"status": "non_release",
"favorite": false,
"archived": false,
"filters": [
{"key": "description",
"value": "data exploration xyz",
"include": true}
]
}'

List Internal Data Asset Files

You can now list the files of an Internal Data Asset via the API.

List Internal Data Asset Files

curl -H "Content-Type: application/json" -u ${CUSTOM_KEY}: -X POST https://${co_domain}/api/v1/data_assets/${data_asset_id}/files --data-raw '{"path": "subfolder"}'

To list files in an External Data Asset, interact with the S3 bucket directly using e.g. the AWS CLI. S3 information can be obtained from the source_bucket field of the get data asset API.

Get Internal Data Asset File Download URL

This API allows for the generation of a URL to download a file from an Internal Data Asset.

Get Internal Data Asset File Download URL

curl -H "Content-Type: application/json" -u ${CUSTOM_KEY}: -X GET https://${co_domain}/api/v1/data_assets/${data_asset_id}/files/download_url?path=${path_to_file}