Provenance

Extract provenance information from the repository.

Activities

class renku.core.models.provenance.activity.Activity(*args, **kwargs)

Represent an activity in the repository.

compare_to(other)

Compare execution date with another activity; return a positive value if self is executed after the other.

freeze()

Set immutable property.

classmethod from_plan(plan, client_dispatcher, project_gateway, started_at_time, ended_at_time, annotations=None, update_commits=False)

Convert a Plan to a Activity.

static generate_id()

Generate an identifier for an activity.

has_identical_inputs_and_outputs_as(other)

Return true if all input and outputs paths are identical regardless of the order.

property immutable

Return if object is immutable.

property plan_with_values

Get a copy of the associated plan with values from ParameterValues applied.

reassign_oid()

Reassign oid (after assigning a new identifier for example).

class renku.core.models.provenance.activity.ActivityCollection(*args, **kwargs)

Represent a list of activities.

freeze()

Set immutable property.

static generate_id()

Generate an identifier for an activity.

property immutable

Return if object is immutable.

reassign_oid()

Reassign oid (after assigning a new identifier for example).

class renku.core.models.provenance.activity.Association(*, agent=None, id, plan)

Assign responsibility to an agent for an activity.

static generate_id(activity_id)

Generate a Association identifier.

class renku.core.models.provenance.activity.Generation(*, entity, id)

Represent an act of generating a path.

static generate_id(activity_id)

Generate a Generation identifier.

classmethod make_instance(instance)

Return a cached instance if available otherwise create an instance from the given parameters.

class renku.core.models.provenance.activity.Usage(*, entity, id)

Represent a dependent path.

static generate_id(activity_id)

Generate a Usage identifier.

classmethod make_instance(instance)

Return a cached instance if available otherwise create an instance from the given parameters.

Entities

class renku.core.models.entity.Entity(*, checksum, id=None, path, **kwargs)

Represent a file.

static generate_id(checksum, path)

Generate an Entity identifier.

classmethod make_instance(instance)

Return a cached instance if available otherwise create an instance from the given parameters.

class renku.core.models.entity.Collection(*, checksum, id=None, path, members=None)

Represent a directory with files.

static generate_id(checksum, path)

Generate an Entity identifier.

classmethod make_instance(instance)

Return a cached instance if available otherwise create an instance from the given parameters.

Agents

class renku.core.models.provenance.agent.Person(*, affiliation=None, alternate_name=None, email=None, id=None, name)

Represent a person.

classmethod from_dict(data)

Create and instance from a dictionary.

classmethod from_jsonld(data)

Create an instance from JSON-LD data.

classmethod from_string(string)

Create an instance from a ‘Name <email>’ string.

property full_identity

Return name, email, and affiliation.

static generate_id(email, full_identity)

Generate identifier for Person.

static get_full_identity(email, affiliation, name)

Return name, email, and affiliation.

classmethod make_instance(**kwargs)

Instantiate from the given parameters.

property short_name

Gives full name in short form.

class renku.core.models.provenance.agent.SoftwareAgent(*, id, name, **kwargs)

Represent executed software.

property full_identity

Return the identity of this Agent.

classmethod make_instance(**kwargs)

Instantiate from the given parameters.

Annotations

class renku.core.models.provenance.annotation.Annotation(*, id, body=None, source=None)

Represents a custom annotation for a research object.

copy()

Return a copy of this annotation.

static generate_id()

Generate an id for an annotation.

Parameters

class renku.core.models.provenance.parameter.ParameterValue(*, id, parameter_id, value)

Value for a parameter in provenance.

apply_value_to_parameter(plan)

Apply the current value as actual_value on the plan’s parameter.

static generate_id(activity_id)

Generate a default id.