Provenance

Extract provenance information from the repository.

Represent an execution of a Plan.

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

Bases: Persistent

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.

delete(when=None)

Mark the activity as deleted.

property deleted

Return if the activity was deleted.

classmethod from_plan(plan, repository, project_gateway, started_at_time, ended_at_time, annotations=None, id=None)

Convert a Plan to a Activity.

static generate_id(uuid=None)

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 plan_with_values

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

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

Bases: Persistent

Represent a list of activities.

static generate_id()

Generate an identifier for an activity collection.

class renku.domain_model.provenance.activity.Association(*, agent, id, plan)

Bases: object

Assign responsibility to an agent for an activity.

static generate_id(activity_id)

Generate a Association identifier.

class renku.domain_model.provenance.activity.Generation(*args, **kwargs)

Bases: Immutable

Represent an act of generating a path.

Create and return an empty instance of the class.

static generate_id(activity_id)

Generate a Generation identifier.

class renku.domain_model.provenance.activity.HiddenUsage(*args, **kwargs)

Bases: Usage

Represent a dependent path corresponding to a HiddenInput.

Create and return an empty instance of the class.

class renku.domain_model.provenance.activity.Usage(*args, **kwargs)

Bases: Immutable

Represent a dependent path.

Create and return an empty instance of the class.

static generate_id(activity_id)

Generate a Usage identifier.

class renku.domain_model.provenance.activity.WorkflowFileActivityCollection(*args, **kwargs)

Bases: ActivityCollection

Represent activities of a workflow file execution.

classmethod from_activities(plan, project_gateway, activities)

Create an instance from a list of Activity.

static generate_id()

Generate an identifier.

Represent provenance agents.

class renku.domain_model.provenance.agent.Agent(*args, **kwargs)

Bases: Slots

Represent executed software.

Create and return an empty instance of the class.

property full_identity

Return the identity of this Agent.

class renku.domain_model.provenance.agent.Person(*args, **kwargs)

Bases: Agent

Represent a person.

Create and return an empty instance of the class.

classmethod from_dict(data)

Create and instance from a dictionary.

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.

property short_name

Gives full name in short form.

class renku.domain_model.provenance.agent.SoftwareAgent(*args, **kwargs)

Bases: Agent

Represent executed software.

Create and return an empty instance of the class.

Represent an annotation for a workflow.

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

Bases: object

Represents a custom annotation for a research object.

copy()

Return a copy of this annotation.

static generate_id()

Generate an id for an annotation.

Classes for tracking parameter values in provenance.

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

Bases: object

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.