Profile Information

Name: Research Infrastructure Shareable Experiments RO-Crate Profile (RISE RO-Crate Profile)

Version: 1.0.0

Authors:

Overview

An RO-Crate profile for packaging metadata and artifacts of experiments conducted in research infrastructures. It defines a vocabulary to describe entities like executed commands, experiment nodes, and resulting data to enable transparent and reproducible experimentation.

Resources

The following resources are part of this profile.

Profile Definition

The following resources form the core definition of this profile:

Profile Crate — ro-crate-metadata.json
External type mappings — types.csv
Profile vocabulary — vocabulary.csv
JSON-LD context — context.jsonld

Developer Resources

The following resources help developers implement or verify crates against this profile:

JSON Schema — rise-ro-crate-profile-schema.json
TypeScript interfaces — rise-ro-crate-profile.ts
Pydantic models — rise_ro_crate_profile_pydantic.py

This profile builds upon the following specifications:

Vocabulary

RootDataEntry

Inherits from: Dataset (Schema.org)
Description: The root data entity that represents the crate, as defined by RO-Crate.

Property	Property Source	Type	Type Source	Required?	Description
`@id`		URL	Schema.org	Required	Set to './' as defined by RO-Crate
`@type`		Text	Schema.org	Required	Set to the Dataset type as defined by RO-Crate
`name`	Schema.org	Text	Schema.org	Required	Name of the crate
`description`	Schema.org	Text	Schema.org	Optional	Description of the crate
`dateCreated`	Schema.org	DateTime	Schema.org	Required	Creation timestamp
`dateModified`	Schema.org	DateTime	Schema.org	Required	Modification timestamp
`datePublished`	Schema.org	DateTime	Schema.org	Required	Publication timestamp
`author`	Schema.org	List of (Person or Organization)	Schema.org	Required	Authors of the crate
`contributor`	Schema.org	List of (Role)	Schema.org	Optional	Authors of the crate with assigned roles
`keywords`	Schema.org	List of (Text)	Schema.org	Optional	Keywords of the crate
`license`	Schema.org	URL	Schema.org	Optional	License of the crate
`archivedAt`	Schema.org	List of (URL or WebPage)	Schema.org	Optional	If copies of the crate are available online
`citation`	Schema.org	List of (ScholarlyArticle or CreativeWork)	Schema.org	Optional	If the crate is used in publications
`mainEntity`	Schema.org	Experiment	RISE RO-Crate Profile	Conditionally Required	If the crate contains a single experiment (mutually exclusive with mentions)
`mentions`	Schema.org	List of (Experiment)	RISE RO-Crate Profile	Conditionally Required	If the crate contains multiple experiments (mutually exclusive with mainEntity)

Experiment

Inherits from: CreativeWork (Schema.org)
Description: An experiment conducted in a research infrastructure.

Property	Property Source	Type	Type Source	Required?	Description
`@id`		URL	Schema.org	Required	Local identifier (e.g. '#') or URI to the experiment file
`@type`		Text	Schema.org	Required	Set to the Experiment type
`name`	Schema.org	Text	Schema.org	Conditionally Required	Name of the experiment (required if the crate contains multiple experiments)
`description`	Schema.org	Text	Schema.org	Optional	Description of the experiment
`dateCreated`	Schema.org	DateTime	Schema.org	Conditionally Required	Creation timestamp (required if the crate contains multiple experiments)
`dateModified`	Schema.org	DateTime	Schema.org	Conditionally Required	Modification timestamp (required if the crate contains multiple experiments)
`author`	Schema.org	List of (Person or Organization)	Schema.org	Conditionally Required	Authors of the experiment (required if the crate contains multiple experiments)
`contributor`	Schema.org	List of (Role)	Schema.org	Optional	Authors of the experiment with assigned roles
`keywords`	Schema.org	List of (Text)	Schema.org	Optional	Keywords of the experiment
`encodingFormat`	Schema.org	Text or URL	Schema.org	Optional	If the identifier is a URI to a file
`executedCommands`	RISE RO-Crate Profile	List of (CommandFile or CommandFileLooped or CommandFileReset or CommandFileBootstrap or CommandFileSetup or CommandFileCopy)	RISE RO-Crate Profile	Required	Executed commands on the experiment nodes
`resultData`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to result data of the executed commands
`experimentNodes`	RISE RO-Crate Profile	List of (ExperimentNode)	RISE RO-Crate Profile	Required	Experiment nodes that are part of the experiment
`experimentWorkflow`	RISE RO-Crate Profile	File	Schema.org	Optional	Link to a file that describes the experiment workflow
`supplementaryData`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to additional data that is relevant to the experiment
`includedOSImages`	RISE RO-Crate Profile	List of (OSImage)	RISE RO-Crate Profile	Optional	OS images that are part of the experiment
`energyMeasurements`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to energy measurement data of the executed commands
`experimentController`	RISE RO-Crate Profile	List of (CreativeWork or SoftwareApplication)	Schema.org	Required	Software or tools used for the experiment management and execution

File

Inherits from: File (Schema.org)
Description: An RO-Crate data entity for files. Defined as an alias for the Schema.org MediaObject type, listed here for reference.

Property	Property Source	Type	Type Source	Required?	Description
`@id`		URL	Schema.org	Required	Relative or absolute URI to file
`@type`		Text	Schema.org	Required	Set to the File type as defined by RO-Crate
`name`	Schema.org	Text	Schema.org	Required	Filename or human-readable name
`description`	Schema.org	Text	Schema.org	Optional	Description of the file
`keywords`	Schema.org	List of (Text)	Schema.org	Optional	Keywords of the file
`contentSize`	Schema.org	Text	Schema.org	Required	File size in bytes
`dateCreated`	Schema.org	DateTime	Schema.org	Required	Creation timestamp
`dateModified`	Schema.org	DateTime	Schema.org	Required	Modification timestamp
`encodingFormat`	Schema.org	Text or URL	Schema.org	Optional	IANA mediatype or link to contextual entry
`exampleOfWork`	Schema.org	CommandFile or LoopRun	RISE RO-Crate Profile	Optional	If the file is part of a CommandFile or LoopRun

Dataset

Inherits from: Dataset (Schema.org)
Description: An RO-Crate data entity for directories, listed here for reference.

Property	Property Source	Type	Type Source	Required?	Description
`@id`		URL	Schema.org	Required	Relative or absolute URI to directory
`@type`		Text	Schema.org	Required	Set to the Dataset type as defined by RO-Crate
`name`	Schema.org	Text	Schema.org	Required	Directory name or human-readable name
`description`	Schema.org	Text	Schema.org	Optional	Description of the directory
`keywords`	Schema.org	List of (Text)	Schema.org	Optional	Keywords of the directory
`contentSize`	Schema.org	Text	Schema.org	Optional	Directory size in bytes
`dateCreated`	Schema.org	DateTime	Schema.org	Required	Creation timestamp
`dateModified`	Schema.org	DateTime	Schema.org	Required	Modification timestamp
`hasPart`	Schema.org	List of (File or Dataset)	Schema.org	Optional	Links to files in the directory
`exampleOfWork`	Schema.org	CommandFile or LoopRun	RISE RO-Crate Profile	Optional	If the directory is part of a CommandFile or LoopRun

CommandFile

Inherits from: File (RISE RO-Crate Profile)
Description: A file containing commands to be executed on an experiment node.

Property	Property Source	Type	Type Source	Required?	Description
`startTime`	Schema.org	DateTime	Schema.org	Required	Timestamp when the command starts
`endTime`	Schema.org	DateTime	Schema.org	Required	Timestamp when the command finishes
`duration`	Schema.org	Duration	Schema.org	Required	Duration of the command
`executedOn`	RISE RO-Crate Profile	ExperimentNode	RISE RO-Crate Profile	Required	Experiment node executing the command
`variableSet`	RISE RO-Crate Profile	File	Schema.org	Optional	Link to a variable set file
`status`	RISE RO-Crate Profile	Text or File	Schema.org	Required	Return code or link to the status file
`stdout`	RISE RO-Crate Profile	File	Schema.org	Required	Link to the stdout file
`stderr`	RISE RO-Crate Profile	File	Schema.org	Required	Link to the stderr file
`resultData`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to result data
`invokedCommands`	RISE RO-Crate Profile	List of (CommandFile)	RISE RO-Crate Profile	Optional	Links to invoked subcommands
`invokedBy`	RISE RO-Crate Profile	CommandFile or LoopRun	RISE RO-Crate Profile	Optional	If the command is invoked by a parent command
`energyMeasurements`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to energy measurement data

CommandFileLooped

Inherits from: File (RISE RO-Crate Profile)
Description: A command file that iterates over an array of parameters.

Property	Property Source	Type	Type Source	Required?	Description
`startTime`	Schema.org	DateTime	Schema.org	Required	Timestamp when the command starts
`endTime`	Schema.org	DateTime	Schema.org	Required	Timestamp when the command finishes
`duration`	Schema.org	Duration	Schema.org	Required	Duration of the command
`executedOn`	RISE RO-Crate Profile	ExperimentNode	RISE RO-Crate Profile	Required	Experiment node executing the command
`variableSet`	RISE RO-Crate Profile	File	Schema.org	Optional	Link to a variable set file
`loopRuns`	RISE RO-Crate Profile	List of (LoopRun)	RISE RO-Crate Profile	Required	Links to the individual loop runs

LoopRun

Inherits from: File (RISE RO-Crate Profile)
Description: A single run of a looped command file.

Property	Property Source	Type	Type Source	Required?	Description
`startTime`	Schema.org	DateTime	Schema.org	Required	Timestamp when the run starts
`endTime`	Schema.org	DateTime	Schema.org	Required	Timestamp when the run finishes
`duration`	Schema.org	Duration	Schema.org	Required	Duration of the run
`runOfLoopedCommand`	RISE RO-Crate Profile	CommandFileLooped	RISE RO-Crate Profile	Required	Link to the looped command file
`status`	RISE RO-Crate Profile	Text or File	Schema.org	Required	Return code or link to the status file
`stdout`	RISE RO-Crate Profile	File	Schema.org	Required	Link to the stdout file
`stderr`	RISE RO-Crate Profile	File	Schema.org	Required	Link to the stderr file
`resultData`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to result data
`invokedCommands`	RISE RO-Crate Profile	List of (CommandFile)	RISE RO-Crate Profile	Optional	Links to invoked subcommands
`energyMeasurements`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to energy measurement data

CommandFileBootstrap

Inherits from: CommandFile (RISE RO-Crate Profile)
Description: A command file for bootstrapping an experiment node.

Property	Property Source	Type	Type Source	Required?	Description

CommandFileSetup

Inherits from: CommandFile (RISE RO-Crate Profile)
Description: A command file for setting up an experiment node.

Property	Property Source	Type	Type Source	Required?	Description

CommandFileReset

Inherits from: CommandFile (RISE RO-Crate Profile)
Description: A command file for resetting an experiment node.

Property	Property Source	Type	Type Source	Required?	Description
`bootedImage`	RISE RO-Crate Profile	OSImage or ContainerImage	RISE RO-Crate Profile, Workflow Run Crate	Required	Link to the booted image
`bootParameters`	RISE RO-Crate Profile	List of (Text)	Schema.org	Optional	List of boot parameters
`bootstrapCommands`	RISE RO-Crate Profile	List of (CommandFileBootstrap)	RISE RO-Crate Profile	Optional	Links to invoked bootstrap commands
`setupCommands`	RISE RO-Crate Profile	List of (CommandFileSetup)	RISE RO-Crate Profile	Optional	Links to invoked setup commands

OSImage

Inherits from: OperatingSystem (Schema.org)
Description: An operating system image booted on an experiment node.

Property	Property Source	Type	Type Source	Required?	Description
`name`	Schema.org	Text	Schema.org	Required	Name of the image
`description`	Schema.org	Text	Schema.org	Optional	Description of the image
`fileSize`	Schema.org	Text	Schema.org	Required	Size of the image
`archivedAt`	Schema.org	URL	Schema.org	Optional	If the image is available online
`hasPart`	Schema.org	List of (File or Dataset)	Schema.org	Optional	Links to image data if included in the crate

CommandFileCopy

Inherits from: CommandFile (RISE RO-Crate Profile)
Description: A command file for copying data to an experiment node.

Property	Property Source	Type	Type Source	Required?	Description
`sourcePath`	RISE RO-Crate Profile	Text	Schema.org	Required	Source path of the data to be copied
`destinationPath`	RISE RO-Crate Profile	Text	Schema.org	Required	Destination path of the data to be copied
`recursiveCopy`	RISE RO-Crate Profile	Boolean	Schema.org	Required	If the data is copied recursively
`copiedData`	RISE RO-Crate Profile	List of (File or Dataset)	Schema.org	Optional	Links to copied data if included in the crate

ExperimentNode

Inherits from: Thing (Schema.org)
Description: An experiment node of a research infrastructure.

Property	Property Source	Type	Type Source	Required?	Description
`@id`		Text	Schema.org	Required	Local identifier (e.g. '#') or URI of the experiment node
`@type`		Text	Schema.org	Required	Set to the Thing type
`name`	Schema.org	Text	Schema.org	Required	Hostname of the experiment node
`description`	Schema.org	Text	Schema.org	Optional	Description of the experiment node
`hardware`	RISE RO-Crate Profile	File	Schema.org	Optional	Link to a hardware file of the experiment node
`topology`	RISE RO-Crate Profile	File	Schema.org	Optional	Link to a network topology file of the experiment node
`visualizedTopology`	RISE RO-Crate Profile	File	Schema.org	Optional	Link to a visualized network topology file of the experiment node