openminds.computation

Provenance of computational workflows in neuroscience, including simulations, data analysis and visualizations.

class Environment(name=None, configuration=None, description=None, hardware=None, software=None, used_for=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, Environment

Structured information on the computer system or set of systems in which a computation is deployed and executed.

Parameters:
class HardwareSystem(name=None, description=None, used_by=None, version_identifier=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, HardwareSystem

Structured information about computing hardware.

Parameters:
  • description (str) – Longer statement or account giving the characteristics of the hardware system.

  • name (str) – Word or phrase that constitutes the distinctive designation of the hardware system.

  • version_identifier (str) – Term or code used to identify the version of something.

  • used_by (Environment) – reverse of ‘hardware’

class LaunchConfiguration(name=None, arguments=None, description=None, environment_variable=None, environment_variables=None, executable=None, is_launch_configuration_of=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, LaunchConfiguration

Structured information about the launch of a computational process.

Parameters:
  • arguments (str) – no description available

  • description (str) – Longer statement or account giving the characteristics of the launch configuration.

  • environment_variable (PropertyValueList) – no description available

  • executable (str) – no description available

  • name (str) – Word or phrase that constitutes the distinctive designation of the launch configuration.

  • is_launch_configuration_of (DataAnalysis, DataCopy, GenericComputation, ModelValidation, Optimization, Simulation, Visualization) – reverse of ‘launch_configuration’

class DataAnalysis(lookup_label=None, custom_property_sets=None, description=None, end_time=None, environment=None, informed=None, inputs=None, is_part_of=None, launch_configuration=None, outputs=None, performed_by=None, recipe=None, resource_usages=None, start_time=None, started_by=None, status=None, study_targets=None, tags=None, techniques=None, was_informed_by=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, DataAnalysis

Structured information on inspecting, cleansing, transforming, and modelling data.

Parameters:
class Simulation(lookup_label=None, custom_property_sets=None, description=None, end_time=None, environment=None, informed=None, inputs=None, is_part_of=None, launch_configuration=None, outputs=None, performed_by=None, recipe=None, resource_usages=None, start_time=None, started_by=None, status=None, study_targets=None, tags=None, techniques=None, was_informed_by=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, Simulation

Structured information about a process of running simulations of a computational model.

Parameters:
class ModelValidation(lookup_label=None, custom_property_sets=None, description=None, end_time=None, environment=None, informed=None, inputs=None, is_part_of=None, launch_configuration=None, outputs=None, performed_by=None, recipe=None, resource_usages=None, score=None, start_time=None, started_by=None, status=None, study_targets=None, tags=None, techniques=None, was_informed_by=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, ModelValidation

Structured information about a process of validating a computational model.

Parameters:
class ValidationTest(name=None, alias=None, comments=None, custodians=None, description=None, developers=None, digital_identifier=None, full_name=None, has_versions=None, homepage=None, how_to_cite=None, is_part_of=None, learning_resources=None, model_scope=None, reference_data_acquisitions=None, scope=None, score_type=None, short_name=None, study_targets=None, versions=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, ValidationTest

Structured information about the definition of a process for validating a computational model.

Parameters:
class ValidationTestVersion(name=None, alias=None, accessibility=None, comments=None, configuration=None, copyright=None, custodians=None, description=None, developers=None, digital_identifier=None, entry_point=None, format=None, full_documentation=None, full_name=None, funding=None, homepage=None, how_to_cite=None, is_alternative_version_of=None, is_input_to=None, is_new_version_of=None, is_old_version_of=None, is_part_of=None, is_version_of=None, keywords=None, learning_resources=None, licenses=None, other_contributions=None, reference_data=None, related_publications=None, release_date=None, repository=None, short_name=None, support_channels=None, version_identifier=None, version_innovation=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, ValidationTestVersion

Structured information about a specific implementation of a validation test.

Parameters:
class Visualization(lookup_label=None, custom_property_sets=None, description=None, end_time=None, environment=None, informed=None, inputs=None, is_part_of=None, launch_configuration=None, outputs=None, performed_by=None, recipe=None, resource_usages=None, start_time=None, started_by=None, status=None, study_targets=None, tags=None, techniques=None, was_informed_by=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, Visualization

Structured information about a process of visualizing a computational model, a computational process, or a dataset.

Parameters:
class Optimization(lookup_label=None, custom_property_sets=None, description=None, end_time=None, environment=None, informed=None, inputs=None, is_part_of=None, launch_configuration=None, outputs=None, performed_by=None, recipe=None, resource_usages=None, start_time=None, started_by=None, status=None, study_targets=None, tags=None, techniques=None, was_informed_by=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, Optimization

Structured information about a process of optimizing a model or a piece of code.

Parameters:
class SoftwareAgent(name=None, activities=None, environment=None, software=None, started=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, SoftwareAgent

Structured information about a piece of software or web service that can perform a task autonomously.

Parameters:
class WorkflowExecution(configuration=None, recipe=None, stages=None, started_by=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, WorkflowExecution

Structured information about an execution of a computational workflow.

Parameters:
class WorkflowRecipe(name=None, alias=None, comments=None, custodians=None, description=None, developers=None, digital_identifier=None, full_name=None, has_versions=None, homepage=None, how_to_cite=None, is_part_of=None, learning_resources=None, short_name=None, versions=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, WorkflowRecipe

Structured information about the description of a prospective workflow.

Parameters:
  • custodians (Consortium, Organization, Person) – The ‘custodian’ is a legal person who is responsible for the content and quality of the data, metadata, and/or code of a research product.

  • description (str) – Longer statement or account giving the characteristics of the workflow recipe.

  • developers (Consortium, Organization, Person) – Legal person that creates or improves products or services (e.g., software, applications, etc.).

  • digital_identifier (DOI) – Digital handle to identify objects or legal persons.

  • full_name (str) – Whole, non-abbreviated name of the workflow recipe.

  • has_versions (WorkflowRecipeVersion) – Reference to variants of an original.

  • homepage (IRI) – Main website of the workflow recipe.

  • how_to_cite (str) – Preferred format for citing a particular object or legal person.

  • short_name (str) – Shortened or fully abbreviated name of the workflow recipe.

  • comments (Comment) – reverse of ‘about’

  • is_part_of (Project, ResearchProductGroup) – reverse of ‘has_parts’

  • learning_resources (LearningResource) – reverse of ‘about’

class WorkflowRecipeVersion(name=None, alias=None, accessibility=None, comments=None, copyright=None, custodians=None, defined=None, description=None, developers=None, digital_identifier=None, format=None, full_documentation=None, full_name=None, funding=None, has_parts=None, homepage=None, how_to_cite=None, is_alternative_version_of=None, is_new_version_of=None, is_old_version_of=None, is_part_of=None, is_version_of=None, keywords=None, learning_resources=None, licenses=None, other_contributions=None, related_publications=None, release_date=None, repository=None, short_name=None, support_channels=None, version_identifier=None, version_innovation=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, WorkflowRecipeVersion

Structured information about a specific implemented version of a workflow recipe.

Parameters:
class LocalFile(name=None, content_description=None, copy_of=None, data_types=None, format=None, hash=None, is_output_of=None, is_used_to_group=None, path=None, special_usage_role=None, storage_size=None, id=None, data=None, space=None, release_status=None)[source]

Bases: KGObject, LocalFile

Structured information about a file that is not accessible via a URL.

Parameters:
  • content_description (str) – no description available

  • copy_of (File) – no description available

  • data_types (DataType) – no description available

  • format (ContentType) – Method of digitally organizing and structuring data or information.

  • hash (Hash) – Term used for the process of converting any data into a single value. Often also directly refers to the resulting single value.

  • name (str) – Word or phrase that constitutes the distinctive designation of the local file.

  • path (str) – no description available

  • special_usage_role (FileUsageRole) – Particular function of something when it is used.

  • storage_size (QuantitativeValue) – Quantitative value defining how much disk space is used by an object on a computer system.

  • is_output_of (DataAnalysis, DataCopy, GenericComputation, ModelValidation, Optimization, Simulation, Visualization) – reverse of ‘outputs’

  • is_used_to_group (FileBundle) – reverse of ‘grouped_by’