Index Interface

exception antelope.interfaces.iindex.IndexRequired

Bases: Exception

exception antelope.interfaces.iindex.InvalidDirection

Bases: Exception

antelope.interfaces.iindex.check_direction(dirn)

exception antelope.interfaces.iindex.InvalidSense

Bases: Exception

antelope.interfaces.iindex.valid_sense(sense)

antelope.interfaces.iindex.comp_dir(direction)

Returns the complementary direction to the provided direction (‘input’ or ‘output’), case-insensitive but unfortunately localized.

(Obviously this whole concept is essentially i18n of a boolean value)

comp_dir also accepts inputs of sense, e.g. ‘source’ and ‘sink’ The implicit direction of a ‘source’ is ‘output’, and so comp_dir(‘Source’) returns ‘Input’, and comp_dir(‘Sink’) returns ‘Output’. :param direction: :return:

antelope.interfaces.iindex.comp_sense(direction)

This inverts the conversion of sense to complementary direction in comp_dir comp_sense(‘Input’) returns ‘Source’ and comp_sense(‘Output’) returns ‘Sink’ :param direction: :return:

antelope.interfaces.iindex.num_dir(direction)

Converts a direction input to a number, in which Input = 0 and Output = 1. :param direction: :return:

class antelope.interfaces.iindex.IndexInterface

Bases: AbstractQuery

CatalogInterface core methods These are the main tools for describing information about the contents of the archive

count(entity_type, **kwargs)

Return a count of the number of entities of the named type :param entity_type: :param kwargs: :return: int

processes(**kwargs)

Generate process entities (reference exchanges only) :param kwargs: keyword search :return:

flows(**kwargs)

Generate flow entities (reference quantity only) :param kwargs: keyword search :return:

flowables(search=None, **kwargs)

Generate known flowables by their canonical name :param search: [None] if provided, filter results (implementation dependent) :param kwargs: :return:

contexts(**kwargs)

Generate known contexts as tuples of canonical names :param kwargs: :return:

quantities(**kwargs)

Generate quantities :param kwargs: keyword search :return:

lcia(**kwargs)

Generate LCIA methodologies or collections of LCIA indicators. type not yet specified :param kwargs: keyword search :return:

lcia_methods(**kwargs)

Generate LCIA methods (nominally, quantities with an ‘Indicator’ property) :param kwargs: keyword search :return:

unmatched_flows(flows, **kwargs)

Takes in a list of flowable terms and generates a sublist of flows that were not recognized as synonyms to any local flows. :param flows: iterable :param kwargs: :return:

targets(flow, direction=None, **kwargs)

Find processes that match the given flow and have a complementary direction :param flow: :param direction: if omitted, return all processes having the given flow as reference, regardless of direction :return:

originate(flow, direction=None, **kwargs)

Find processes that match the given flow and have the same direction :param flow: :param direction: if omitted, return all processes having the given flow as reference, regardless of direction :return: