Configure Interface

exception antelope.interfaces.iconfigure.ConfigRequired

Bases: Exception

class antelope.interfaces.iconfigure.ConfigureInterface

Bases: AbstractQuery

A class for tuning and tweaking the reference flow configuration of processes in an archive.

check_config(config, c_args, **kwargs)

Check that a given configuration tuple is valid :param config: a config option :param c_args: a tuple of args passed to the config optioin :param kwargs: :return:

context_hint(local_term, canonical_context, **kwargs)

Used to map source-specific contexts to canonical contexts in an LCIA engine. The source-specific context name is constructed as ‘%s:%s’ % (origin, local_term) and added as synonym to lcia_engine[canonical_context]

This is not implemented in the same manner as other configs- because the object of configuration is the catalog and not the resource itself. :param local_term: :param canonical_context: :param kwargs: :return:

set_reference(process_ref, flow_ref, direction=None, **kwargs)

Set a particular exchange as a reference flow for a given process. The exchange must already exist. No error if the exchange is already a reference. :param process_ref: :param flow_ref: :param direction: if None, the flow_ref must only appear with one direction :param kwargs: :return:

unset_reference(process_ref, flow_ref, direction=None, **kwargs)

Unset a particular exchange from being a reference. The exchange must already exist. No error if the exchange is already not a reference. :param process_ref: :param flow_ref: :param direction: if None, the flow_ref must only appear with one direction :param kwargs: :return:

characterize_flow(flow_ref, quantity_ref, value, location='GLO', **kwargs)

Add a characterization to the given flow in the given quantity, with respect to the flow’s native reference quantity. Optional location field.

Parameters:

  • flow_ref

  • quantity_ref

  • value

  • location – [‘GLO’]

  • kwargs

Returns:

allocate_by_quantity(process_ref, quantity_ref, **kwargs)

Allocate the multioutput process by partitioning over the reference flows by the specified quantity. :param process_ref: :param quantity_ref: :param kwargs: :return: