metadata.py File Reference

Namespaces
	carputils.bundle.metadata
	Utilities for generating and managing metadata in bundles.

Functions
def	carputils.bundle.metadata.load_metadata_file (exp_dir, bundle_dir)
	Creates an object containing metadata provided by the user in the file exp_dir/codemeta.json, or in bundle_dir/codemeta.json (in this order) and merge it with the metadata template. More...
def	carputils.bundle.metadata.check_critical_fields (metadata_obj)
	Raise warnings if metadata template fields were not filled by the user. More...
def	carputils.bundle.metadata.autopopulate_template (metadata_obj)
	Automatically fills some fields in metadata object. More...
def	carputils.bundle.metadata.autopopulate_authors_names (metadata_obj)
	Create full name of the authors from 'given_name' and 'family_name' fields. More...
def	carputils.bundle.metadata.autopopulate_date (metadata_obj)
	Fills 'date' and 'publication_year' fields in metadata. More...
def	carputils.bundle.metadata.add_env_metadata (metadata_obj)
	Adds to an existing metadata object the environment metadata included by default in the bundle. More...
def	carputils.bundle.metadata.add_exp_name (metadata_obj, exp_name)
	Adds the experiment name to the metadata object if not defined in metadata. More...
def	carputils.bundle.metadata.add_command_line (metadata_obj, exp_filename)
	Adds the command line that should be used to run the same experiment to a metadata object. More...
def	carputils.bundle.metadata.analyze_metadata (metadata_obj)
	Analyzes the metadata and trigger warnings in case some critical metadata is missing. More...
def	carputils.bundle.metadata.get_opencarp_git_hash ()
	Get the git hash of the openCARP version. More...
def	carputils.bundle.metadata.get_latest_opencarp_version ()
	Get the latest version of openCARP. More...

Variables
string	carputils.bundle.metadata.METADATA_FILE = 'codemeta.json'
string	carputils.bundle.metadata.METADATA_TPL_FILE = 'codemeta.json.tpl'