Metadata

The /metadata folder contains essential details about the research project, including the title, research field, description, project authors, and tags. Metadata is critical for releasing a Capsule and enables quicker, more accurate search results via keyword searches. All metadata is indexed and searchable on the Code Ocean Internal Release page.

In a Capsule, the metadata folder has the path of /metadata . While this folder is not visible during a Reproducible Run, it is accessible in any Cloud Workstation.

Metadata Editor

1. Click the /metadata folder to open the Metadata Editor.

2. Enter the information in the text fields provided:

• Name:

  • Enter the Capsule's title.

  • Use a name that's easy to search and understand for both yourself and collaborators.

  • Follow internal naming conventions if applicable.

• Research field:

  • Specify the relevant research domain or field.

• Description:

  • Use markdown supported text to provide a clear description of the Capsule and ensure its purpose is easily understood by you and your collaborators in the future.

• Authors:

  • List the names of all individuals who contributed to creating the Capsule.

• Tags:

  • Add relevant keywords to improve searchability and discoverability.

The metadata.yml file

Most of the information you enter in the Metadata Editor is stored in the metadata.yml file within the /metadata folder. It can be opened and edited directly as a plain text file.

The Capsule ID

The Capsule ID is listed on the metadata page and is required for certain API operations, such as the Get Capsule API. Click the clipboard icon next to the Capsule ID to copy it.

Uploading a Cover Image

Adding a representative cover image enhances intelligibility and discoverability on Code Ocean’s Internal Releases Dashboard. To update your Capsule's cover image:

1. Navigate to your Capsule's /metadata folder.

2. Hover over the current image.

3. Click Upload Image.