pyilcd package#

Submodules#

pyilcd.common module#

Common custom ILCD Python classes.

class pyilcd.common.Category#

Bases: ElementBase

Name of the category of this elementary flow.

property catId#

May be used by LCA software for it’s category system. If used the identifer should be identical to the on defined in the referenced category file. Identifiers can be UUIDs, but also other forms are possible.]

Type:: Unique identifier of the category. [Note

property level#: Hierarchy level (1,2,…), if the categorization system is hierachical, otherwise emtpy or not used.

class pyilcd.common.Class#

Bases: ElementBase

Name of the class.

property classId#

If such identifiers are also defined in the referenced category file, they should be identical. Identifiers can be UUID’s, but also other forms are allowed.]

Type:: Unique identifier for the class. [Notes

property level#: If more than one class is specified in a hierachical classification system, the hierarchy level (1,2,…) could be specified with this attribute of class.

class pyilcd.common.Classification#

Bases: ElementBase

Optional statistical or other classification of the data set. Typically also used for structuring LCA databases.

property classes#: URL or file name of a file listing all classes of this classification system. [Notes: the referenced file has to be in form of the “ILCDClassification.xml” format. If a classification file is specified, the “class” entry should correspond to the classes defined in the classification file.]

property classesList: List[Class]#: Name of the class.

property name#: Name of the classification system.

class pyilcd.common.ClassificationInformation#

Bases: ElementBase

Hierarchical classification of the good, service, or process. (Note: This entry is NOT required for the identification of a Process. It should nevertheless be avoided to use identical names for Processes in the same category.

property classifications: List[Classification]#: Optional statistical or other classification of the data set. Typically also used for structuring LCA databases.

class pyilcd.common.CommissionerAndGoal#

Bases: ElementBase

Basic information about goal and scope of the data set.

property intendedApplications#: Documentation of the intended application(s) of data collection and data set modelling. This indicates / includes information on the level of detail, the specifidity, and the quality ambition inthe effort.

property project#: Project within which the data set was modelled in its present version. [Note: If the project was published e.g. as a report, this can be referenced in the “Publication of data set in:” field in the “Publication and ownership” sub-section.

property referenceToCommissioner: List[GlobalReference]#: “Contact data set” of the commissioner / financing party of the data collection / compilation and of the data set modelling. For groups of commissioners, each single organisation should be named. For data set updates and for direct use of data from formerly commissioned studies, also the original commissioner should be named.

class pyilcd.common.Compliance#

Bases: ComplianceGroup

One compliance declaration

class pyilcd.common.ComplianceDeclarations#

Bases: ElementBase

Statements on compliance of several data set aspects with compliance requirements as defined by the referenced compliance system (e.g. an EPD scheme, handbook of a national or international data network such as the ILCD, etc.).

property compliances: List[Compliance]#: One compliance declaration

class pyilcd.common.ComplianceGroup#

Bases: ElementBase

Common group.

property approvalOfOverallCompliance#: Official approval whether or not and in how far the data set meets all the requirements of the “Compliance system” refered to. This approval should be issued/confirmed by the owner of that compliance system, who is identified via the respective “Contact data set”.

property referenceToComplianceSystem: GlobalReference#: Source data set” of the “Compliance system” that is declared to be met by the data set.

class pyilcd.common.DataEntryByGroup1#

Bases: ElementBase

Common group.

property referenceToDataSetFormat: List[GlobalReference]#: “Source data set” of the used version of the ILCD format. If additional data format fields have been integrated into the data set file, using the “namespace” option, the used format namespace(s) are to be given. This is the case if the data sets carries additional information as specified by other, particular LCA formats, e.g. of other database networks or LCA softwares.

property timeStamp#: Date and time stamp of data set generation, typically an automated entry (“last saved”).

class pyilcd.common.DataEntryByGroup2#

Bases: ElementBase

Common group.

property referenceToPersonOrEntityEnteringTheData: GlobalReference#: “”Contact data set” of the responsible person or entity that has documented this data set, i.e. entered the data and the descriptive information.

class pyilcd.common.DataQualityIndicator#

Bases: ElementBase

Data quality indicators serve to provide the reviewed key information on the data set in a defined, computer-readable (and hence searchable) form. This serves to support LCA practitioners to identify/select the highest quality and most appropriate data sets.

property name#: Name of indicator

property value#: Value of indicator

class pyilcd.common.DataQualityIndicators#

Bases: ElementBase

property dataQualityIndicators: List[DataQualityIndicator]#: Data quality indicators serve to provide the reviewed key information on the data set in a defined, computer-readable (and hence searchable) form. This serves to support LCA practitioners to identify/select the highest quality and most appropriate data sets.

class pyilcd.common.FlowCategorization#

Bases: ElementBase

Identifying category/compartment information exclusively used for elementary flows. E.g. “Emission to air”, “Renewable resource”, etc.

property categories#: URL or file name of a file containing all categories of this categorization system. [Note: The file is to be in form of the “ILCDCategories.xml” format. If a category file is specified, only categories of the referenced categories file should be used.]

property categoryList: List[Category]#: Name of the category of this elementary flow..

property name#: Name of the categorization system. E.g. “ILCD 1.1” or another elementary flow categorization/compartment scheme applied, as defined e.g. in other LCA database (systems).

class pyilcd.common.FlowCategoryInformation#

Bases: ElementBase

Hierachical classification of the Flow property foreseen to be used to structure the Flow property content of the database. (Note: This entry is NOT required for the identification of the Flow property data set. It should nevertheless be avoided to use identical names for Flow properties in the same class.

property classifications: List[Classification]#: Optional statistical or other classification of the data set. Typically also used for structuring LCA databases.

property elementaryFlowCategorization: List[FlowCategorization]#: Identifying category/compartment information exclusively used for elementary flows. E.g. “Emission to air”, “Renewable resource”, etc.

class pyilcd.common.GlobalReference#

Bases: ElementBase

Represents a reference to another dataset or file. Either refObjectId and version, or uri, or both have to be specified.

property refObjectId#: UUID of the referenced object

property shortDescription#: Short, clear-text summary of the referenced object that can be used as a hint what to expect behind the reference in cases where it cannot be resolved.

property subReference#: Valid only for references of type “source data set”. Allows to make references to sections, pages etc. within a source.

property type#: (required) - indicates the type of the referenced dataset/file. One of GlobalReferenceTypeValues.

property uri#: URI of the referenced object

property version#: version number of the referenced object

class pyilcd.common.Method#

Bases: ElementBase

Validation method(s) used in the respective “Scope of review”.

property name#: Method name

class pyilcd.common.PublicationAndOwnershipGroup1#

Bases: ElementBase

Common group.

property dataSetVersion#: Version number of data set. First two digits refer to major updates, the second two digits to minor revisions and error corrections etc. The third three digits are intended for automatic and internal counting of versions during data set development. Together with the data set’s UUID, the “Data set version” uniquely identifies each data set.

property permanentDataSetURI#: URI (i.e. an internet address) of the original of this data set [Note: This equally globally unique identifier supports users and software tools to identify and retrieve the original version of a data set via the internet or to check for available updates. The URI must not represent an existing WWW address, but it should be unique and point to the data access point, e.g. by combining the data owner’s www path with the data set’s UUID, e.g. http://www.mycompany.com/lca/processes/50f12420-8855-12db-b606-0900210c9a66.]

property referenceToPrecedingDataSetVersion: List[GlobalReference]#: Last preceding data set, which was replaced by this version. Either a URI of that data set (i.e. an internet address) or its UUID plus version number is given (or both).

class pyilcd.common.PublicationAndOwnershipGroup2#

Bases: ElementBase

Common group.

property referenceToUnchangedRepublication: GlobalReference#: “Source data set” of the publication, in which this data set was published for the first time. [Note: This refers to exactly this data set as it is, without any format conversion, adjustments, flow name mapping, etc. In case this data set was modified/converted, the original source is documented in “Converted original data set from:” in section “Data entry by”.]

property workflowAndPublicationStatus#: Workflow or publication status of data set. Details e.g. of foreseen publication dates should be provided on request by th “Data set owner”.

class pyilcd.common.PublicationAndOwnershipGroup3#

Bases: ElementBase

Common group.

property accessRestrictions#: Access restrictions / use conditions for this data set as free text or referring to e.g. license conditions. In case of no restrictions “None” is entered.

property copyright#: Indicates whether or not a copyright on the data set exists. Decided upon by the “Owner of data set”. [Note: See also field “Access and use restrictions”.]

property licenseType#: Type of license that applies to the access and use of this data set.

property referenceToEntitiesWithExclusiveAccess: List[GlobalReference]#: “Contact data set” of those entities or persons (or groups of these), to which an exclusive access to this data set is granted. Mainly intended to be used in confidentiality management in projects. [Note: See also field “Access and use restrictions”.]

class pyilcd.common.Scope#

Bases: ElementBase

Scope of review regarding which aspects and components of the data set was reviewed or verified. In case of aggregated e.g. LCI results also and on which level of detail (e.g. LCI results only, included unit processes, …) the review / verification was performed.

property method: List[Method]#: Validation method(s) used in the respective “Scope of review”.

property name#: Scope name

class pyilcd.common.ValidationGroup1#

Bases: ElementBase

Common group.

property dataQualityIndicators: DataQualityIndicators#: Data quality indicators serve to provide the reviewed key information on the data set in a defined, computer-readable (and hence searchable) form. This serves to support LCA practitioners to identify/select the highest quality and most appropriate data sets.

property reviewDetails#: Summary of the review. All the following items should be explicitly addressed: Representativeness, completeness, and precision of Inputs and Outputs for the process in its documented location, technology and time i.e. both completeness of technical model (product, waste, and elementary flows) and completeness of coverage of the relevant problem fields (environmental, human health, resource use) for this specific good, service, or process. Plausibility of data. Correctness and appropriateness of the data set documentation. Appropriateness of system boundaries, cut-off rules, LCI modelling choices such as e.g. allocation, consistency of included processes and of LCI methodology. If the data set comprises pre-calculated LCIA results, the correspondence of the Input and Output elementary flows (including their geographical validity) with the applied LCIA method(s) should be addressed by the reviewer. An overall quality statement on the data set may be included here.

property scope: Scope#: Scope of review regarding which aspects and components of the data set was reviewed or verified. In case of aggregated e.g. LCI results also and on which level of detail (e.g. LCI results only, included unit processes, …) the review / verification was performed.

class pyilcd.common.ValidationGroup3#

Bases: ElementBase

Common group.

property otherReviewDetails#: Further information from the review process, especially comments received from third parties once the data set has been published or additional reviewer comments from an additional external review.

property referenceToCompleteReviewReport: GlobalReference#: “”Source data set” of the complete review report.

property referenceToNameOfReviewerAndInstitution: GlobalReference#: “Contact data set” of reviewer. The full name of reviewer(s) and institution(s) as well as a contact address and/or email should be provided in that contact data set.

pyilcd.config module#

Defaults configuration.

class pyilcd.config.Defaults#

Bases: object

Stores default values for ILCD attributes used when no value exists.

DYNAMIC_DEFAULTS: ClassVar[Dict[str, Dict[str, Callable[[ElementBase], str]]]] = {}#

SCHEMA_CONTACT_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_ContactDataSet.xsd'#

SCHEMA_DIR: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas'#

SCHEMA_FLOW_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_FlowDataSet.xsd'#

SCHEMA_FLOW_PROPERTY_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_FlowPropertyDataSet.xsd'#

SCHEMA_PROCESS_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_ProcessDataSet.xsd'#

SCHEMA_SOURCE_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_SourceDataSet.xsd'#

SCHEMA_UNIT_GROUP_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_UnitGroupDataSet.xsd'#

STATIC_DEFAULTS: ClassVar[Dict[str, Dict[str, str]]] = {'Classification': {'name': 'ILCD'}, 'FlowCategorization': {'name': 'ILCD'}, 'ProcessDataset': {'metaDataOnly': 'false'}}#

classmethod config_defaults(config_file)#

Fully/ partially overrides defaults. Parameters: config_file: path for config file.

Parameters:: config_file (str) –
Return type:: None

pyilcd.contact_dataset module#

Custom ILCD Python classes for ContactDataSet of ILCD schema.

class pyilcd.contact_dataset.AdministrativeInformation#

Bases: ElementBase

Information on data set management and administration.

property dataEntryBy: DataEntryBy#: Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

property publicationAndOwnership: PublicationAndOwnership#: Information related to publication and version management of the data set including copyright and access restrictions.

class pyilcd.contact_dataset.ContactDataSet#

Bases: ElementBase

Contact Dataset.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property contactInformation: ContactInformation#: Contact information,

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.contact_dataset.ContactInformation#

Bases: ElementBase

Contact information.

property dataSetInformation: DataSetInformation#: Data set information.

class pyilcd.contact_dataset.DataEntryBy#

Bases: DataEntryByGroup1

Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

class pyilcd.contact_dataset.DataSetInformation#

Bases: ElementBase

Data set information.

property UUID#: Automatically generated Universally Unique Identifier of this data set. Together with the “Data set version”, the UUID uniquely identifies each data set.

property centralContactPoints#: Alternative address / contact details for the contact. Provides contact information in case e.g. the person or group represented by this contact has left the organisation or changed office/telephone. This alternative contact point can hence contain also a central telephone number, e-mail, www-address etc. of the organisation.

property classificationInformation: ClassificationInformation#: Hierachical classification of the contact foreseen to be used to structure the contact content of the database. (Note: This entry is NOT required for the identification of the contact data set. It should nevertheless be avoided to use identical names for contacts in the same class.

property contactAddresses#: Mail address of the contact; specific for the person, working group, or department. [Note: A general contact point to the organisation is to be given in “General contact point”.]

property contactDescriptionOrComments#: Free text for additional description of the organisation or person of the contact, such as organisational profile, person responsibilities, etc.

property email#: Contact’s e-mail address.

property names#: Name of the person, working group, organisation, or database network, which is represented by this contact data set.

property referenceToContact: List[GlobalReference]#: “Contact data set”s of working groups, organisations or database networks to which EITHER this person or entity OR this database, data set format, or compliance system belongs. [Note: This does not necessarily imply a legally binding relationship, but may also be a voluntary membership.]

property referenceToLogo: GlobalReference#: “Source data set” of the logo of the organisation or source to be used in reports etc.

property shortNames#: Short name for the contact, that is used for display e.g. of links to this data set (especially in case the full name of the contact is rather long, e.g. “FAO” for “Food and Agriculture Organization”).

property telefax#: Contact’s fax number(s) including country and regional codes.

property telephone#: Contact’s phone number(s) including country and regional codes.

property wwwAddress#: Web-address of the person, working group, organisation or database network.

class pyilcd.contact_dataset.PublicationAndOwnership#

Bases: PublicationAndOwnershipGroup1

Information related to publication and version management of the data set including copyright and access restrictions.

property referenceToOwnershipOfDataSet: GlobalReference#: “Contact data set” of the person or entity who owns this data set. (Note: this is not necessarily the publisher of the data set.)

pyilcd.core module#

Core ILCD module containing parsing and saving functionalities.

class pyilcd.core.ContactDatasetLookup#

Bases: CustomElementClassLookup

Custom XML lookup class for ILCD ContactDataset files.

lookup(unused_node_type, unused_document, unused_namespace, name)#

Maps ILCD ContactDataset XML elements to custom ContactDataset classes.

Parameters:: name (str) –
Return type:: type

class pyilcd.core.FlowDatasetLookup#

Bases: CustomElementClassLookup

Custom XML lookup class for ILCD FlowDataset files.

lookup(unused_node_type, unused_document, unused_namespace, name)#

Maps ILCD FlowDataset XML elements to custom FlowDataset classes.

Parameters:: name (str) –
Return type:: type

class pyilcd.core.FlowPropertyDatasetLookup#

Bases: CustomElementClassLookup

Custom XML lookup class for ILCD FlowPropertyDataset files.

lookup(unused_node_type, unused_document, unused_namespace, name)#

Maps ILCD FlowPropertyDataset XML elements to custom FlowPropertyDataset classes.

Parameters:: name (str) –
Return type:: type

class pyilcd.core.ProcessDatasetLookup#

Bases: CustomElementClassLookup

Custom XML lookup class for ILCD ProcessDataset files.

lookup(unused_node_type, unused_document, unused_namespace, name)#

Maps ILCD ProcessDataset XML elements to custom ProcessDataset classes.

Return type:: type

class pyilcd.core.SourceDatasetLookup#

Bases: CustomElementClassLookup

Custom XML lookup class for ILCD SourceDataset files.

lookup(unused_node_type, unused_document, unused_namespace, name)#

Maps ILCD SourceDataset XML elements to custom SourceDataset classes.

Parameters:: name (str) –
Return type:: type

class pyilcd.core.UnitGroupDatasetLookup#

Bases: CustomElementClassLookup

Custom XML lookup class for ILCD UnitGroupDataset files.

lookup(unused_node_type, unused_document, unused_namespace, name)#

Maps ILCD UnitGroupDataset XML elements to custom UnitGroupDataset classes.

Parameters:: name (str) –
Return type:: type

pyilcd.core.parse_directory_contact_dataset(dir_path, valid_suffixes=None)#

Parses a directory of ILCD Contact Dataset XML files to a list of custom ILCD classes. Parameters: dir_path: the directory path, should contain ILCD Contact Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ContactDataSet]]

pyilcd.core.parse_directory_flow_dataset(dir_path, valid_suffixes=None)#

Parses a directory of ILCD Flow Dataset XML files to a list of custom ILCD classes. Parameters: dir_path: the directory path, should contain ILCD Flow Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowDataSet]]

pyilcd.core.parse_directory_flow_property_dataset(dir_path, valid_suffixes=None)#

Parses a directory of ILCD Flow Property Dataset XML files to a list of custom ILCD classes. Parameters: dir_path: the directory path, should contain ILCD Flow Property Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowPropertyDataSet]]

pyilcd.core.parse_directory_process_dataset(dir_path, valid_suffixes=None)#

Parses a directory of ILCD Process Dataset XML files to a list of custom ILCD classes. Parameters: dir_path: the directory path, should contain ILCD Process Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ProcessDataSet]]

pyilcd.core.parse_directory_source_dataset(dir_path, valid_suffixes=None)#

Parses a directory of ILCD Source Dataset XML files to a list of custom ILCD classes. Parameters: dir_path: the directory path, should contain ILCD Source Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, SourceDataSet]]

pyilcd.core.parse_directory_unit_group_dataset(dir_path, valid_suffixes=None)#

Parses a directory of ILCD Unit Group Dataset XML files to a list of custom ILCD classes. Parameters: dir_path: the directory path, should contain ILCD Unit Group Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, UnitGroupDataSet]]

pyilcd.core.parse_file_contact_dataset(file)#

Parses an ILCD Contact DataSet XML file to custom ILCD classes. Parameters: file: the str|Path path to the Contact DataSet XML file or its StringIO representation. Returns a ContactDataSet class representing the root of the XML file.

Parameters:: file (str | Path | StringIO) –
Return type:: ContactDataSet

pyilcd.core.parse_file_flow_dataset(file)#

Parses an ILCD Flow DataSet XML file to custom ILCD classes. Parameters: file: the str|Path path to the Flow DataSet XML file or its StringIO representation. Returns a FlowDataSet class representing the root of the XML file.

Parameters:: file (str | Path | StringIO) –
Return type:: FlowDataSet

pyilcd.core.parse_file_flow_property_dataset(file)#

Parses an ILCD Flow Property DataSet XML file to custom ILCD classes. Parameters: file: the str|Path path to the Flow Property DataSet XML file or its StringIO representation. Returns a FlowPropertyDataSet class representing the root of the XML file.

Parameters:: file (str | Path | StringIO) –
Return type:: FlowPropertyDataSet

pyilcd.core.parse_file_process_dataset(file)#

Parses an ILCD Process Dataset XML file to custom ILCD classes. Parameters: file: the str|Path path to the ProcessDataset XML file or its StringIO representation. Returns a ProcessDataset class representing the root of the XML file.

Parameters:: file (str | Path | StringIO) –
Return type:: ProcessDataSet

pyilcd.core.parse_file_source_dataset(file)#

Parses an ILCD Source DataSet XML file to custom ILCD classes. Parameters: file: the str|Path path to the Source DataSet XML file or its StringIO representation. Returns a SourceDataSet class representing the root of the XML file.

Parameters:: file (str | Path | StringIO) –
Return type:: SourceDataSet

pyilcd.core.parse_file_unit_group_dataset(file)#

Parses an ILCD Unit Group DataSet XML file to custom ILCD classes. Parameters: file: the str|Path path to the Unit Group DataSet XML file or its StringIO representation. Returns a UnitGroupDataSet class representing the root of the XML file.

Parameters:: file (str | Path | StringIO) –
Return type:: UnitGroupDataSet

pyilcd.core.parse_zip_file_contact_dataset(file_path, valid_suffixes=None)#

Parses a ZIP file of ILCD Contact Dataset XML files to a list of custom ILCD classes. Parameters: file_path: the ZIP file path, should contain ILCD Contact Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ContactDataSet]]

pyilcd.core.parse_zip_file_flow_dataset(file_path, valid_suffixes=None)#

Parses a ZIP file of ILCD Flow Dataset XML files to a list of custom ILCD classes. Parameters: file_path: the ZIP file path, should contain ILCD Flow Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowDataSet]]

pyilcd.core.parse_zip_file_flow_property_dataset(file_path, valid_suffixes=None)#

Parses a ZIP file of ILCD Flow Property Dataset XML files to a list of custom ILCD classes. Parameters: file_path: the ZIP file path, should contain ILCD Flow Property Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowPropertyDataSet]]

pyilcd.core.parse_zip_file_process_dataset(file_path, valid_suffixes=None)#

Parses a ZIP file of ILCD Process Dataset XML files to a list of custom ILCD classes. Parameters: file_path: the ZIP file path, should contain ILCD Process Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ProcessDataSet]]

pyilcd.core.parse_zip_file_source_dataset(file_path, valid_suffixes=None)#

Parses a ZIP file of ILCD Source Dataset XML files to a list of custom ILCD classes. Parameters: file_path: the ZIP file path, should contain ILCD Source Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, SourceDataSet]]

pyilcd.core.parse_zip_file_unit_group_dataset(file_path, valid_suffixes=None)#

Parses a ZIP file of ILCD Unit Group Dataset XML files to a list of custom ILCD classes. Parameters: file_path: the ZIP file path, should contain ILCD Unit Group Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding ILCD classes representing the root of the XML file.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, UnitGroupDataSet]]

pyilcd.core.save_ilcd_file(root, path, fill_defaults=False)#

Saves an ILCD class to an XML file. Parameters: root: the ILCD class representing the root of the XML file. path: the path to save the ILCD XML file. fill_defaults: whether to fill defaults values for attributes or not.

Parameters:

root (ElementBase) –
path (str) –
fill_defaults (bool) –

Return type:

None

pyilcd.core.validate_directory_contact_dataset(dir_path, valid_suffixes=None)#

Validates a directory of ILCD Contact Dataset XML files. Parameters: dir_path: the directory path, should contain ILCD Contact Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_directory_flow_dataset(dir_path, valid_suffixes=None)#

Validates a directory of ILCD Flow Dataset XML files. Parameters: dir_path: the directory path, should contain ILCD Flow Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_directory_flow_property_dataset(dir_path, valid_suffixes=None)#

Validates a directory of ILCD Flow Property Dataset XML files. Parameters: dir_path: the directory path, should contain ILCD Flow Property Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_directory_process_dataset(dir_path, valid_suffixes=None)#

Validates a directory of ILCD Process Dataset XML files. Parameters: dir_path: the directory path, should contain ILCD Process Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_directory_source_dataset(dir_path, valid_suffixes=None)#

Validates a directory of ILCD Source Dataset XML files. Parameters: dir_path: the directory path, should contain ILCD Source Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_directory_unit_group_dataset(dir_path, valid_suffixes=None)#

Validates a directory of ILCD Unit Group Dataset XML files. Parameters: dir_path: the directory path, should contain ILCD Unit Group Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_file_contact_dataset(file)#

Validates an ILCD Contact Dataset XML file against schema. Parameters: file: the str|Path path to the ILCD Contact Dataset XML file or its StringIO representation. Returns None if valid or a list of error strings.

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.core.validate_file_flow_dataset(file)#

Validates an ILCD Flow Dataset XML file against schema. Parameters: file: the str|Path path to the ILCD Flow Dataset XML file or its StringIO representation. Returns None if valid or a list of error strings.

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.core.validate_file_flow_property_dataset(file)#

Validates an ILCD Flow Property Dataset XML file against schema. Parameters: file: the str|Path path to the ILCD Flow Property Dataset XML file or its StringIO representation. Returns None if valid or a list of error strings.

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.core.validate_file_process_dataset(file)#

Validates an ILCD Process Dataset XML file against schema. Parameters: file: the str|Path path to the ILCD Process Dataset XML file or its StringIO representation. Returns None if valid or a list of error strings.

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.core.validate_file_source_dataset(file)#

Validates an ILCD Source Dataset XML file against schema. Parameters: file: the str|Path path to the ILCD Source Dataset XML file or its StringIO representation. Returns None if valid or a list of error strings.

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.core.validate_file_unit_group_dataset(file)#

Validates an ILCD Unit Group Dataset XML file against schema. Parameters: file: the str|Path path to the ILCD Unit Group Dataset XML file or its StringIO representation. Returns None if valid or a list of error strings.

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.core.validate_zip_file_contact_dataset(file_path, valid_suffixes=None)#

Validates a ZIP FILE of ILCD Contact Dataset XML files. Parameters: file_path: the ZIP file path, should contain ILCD Contact Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_zip_file_flow_dataset(file_path, valid_suffixes=None)#

Validates a ZIP FILE of ILCD Flow Dataset XML files. Parameters: file_path: the ZIP file path, should contain ILCD Flow Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_zip_file_flow_property_dataset(file_path, valid_suffixes=None)#

Validates a ZIP FILE of ILCD Flow Property Dataset XML files. Parameters: file_path: the ZIP file path, should contain ILCD Flow Property Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_zip_file_process_dataset(file_path, valid_suffixes=None)#

Validates a ZIP FILE of ILCD Process Dataset XML files. Parameters: file_path: the ZIP file path, should contain ILCD Process Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_zip_file_source_dataset(file_path, valid_suffixes=None)#

Validates a ZIP FILE of ILCD Source Dataset XML files. Parameters: file_path: the ZIP file path, should contain ILCD Source Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.core.validate_zip_file_unit_group_dataset(file_path, valid_suffixes=None)#

Validates a ZIP FILE of ILCD Unit Group Dataset XML files. Parameters: file_path: the ZIP file path, should contain ILCD Unit Group Dataset files. valid_suffixes: a list of valid file suffixes which will only be considered for parsing. If None, defaults to [“.xml”, “.ilcd”]. Returns a list of tuples of file paths and corresponding list of errors, which is None if no errors.

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.flow_dataset module#

Custom ILCD Python classes for FlowDataSet of ILCD schema.

class pyilcd.flow_dataset.AdministrativeInformation#

Bases: ElementBase

Information on data set management and administration.

property dataEntryBy: DataEntryBy#: Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity..

property publicationAndOwnership: PublicationAndOwnership#: Information related to publication and version management of the data set including copyright and access restrictions.

class pyilcd.flow_dataset.DataEntryBy#

Bases: DataEntryByGroup1, DataEntryByGroup2

Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity..

class pyilcd.flow_dataset.DataSetInformation#

Bases: ElementBase

General data set information. Covers the ISO/TS 14048 fields 1.2.1, 1.2.3, 1.2.4, 1.2.5, (1.2.6), (1.2.7),1.2.10.1, 1.2.10.2, 1.2.10.3, and references to 1.2.11 (Flow property) and 1.2.11.2 (Unit).

property casNumber#

Should only be given for (virtually) pure substances, but NOT also for the main constituent of a material or product etc.]

Type:: Chemical Abstract Systems Number of the substance. [Note

property classificationInformation: FlowCategoryInformation#: Hierarchical classification of the good, service, or process. (Note: This entry is NOT required for the identification of a Process. It should nevertheless be avoided to use identical names for Processes in the same category.

property commonUUID#: Automatically generated Universally Unique Identifier of this data set. Together with the “Data set version”, the UUID uniquely identifies each data set.

property generalComments#: Free text for general information about the Flow data set. It may contain information about e.g. the use of the substance, good, service or process in a specific technology or industry-context, information sources used, data selection principles etc.

property name: Name#: General descriptive and specifying name of the flow.

property sumFormula#: Chemical sum formula of the substance.

property synonyms#: Synonyms / alternative names / brands of the good, service, or process. Separated by semicolon.

class pyilcd.flow_dataset.FlowDataSet#

Bases: ElementBase

Covers the INvariable flow information addressed in ISO/TS 14048’s section “Inputs and outputs”

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property flowInformation: FlowInformation#: Covers the INvariable flow information addressed in ISO/TS 14048’s section “Inputs and outputs”

property flowProperties: FlowProperties#: List of flow properties (with all variable information linked to that respective flow).

property locations#: Contains reference to used location table for this dataset.

property modellingAndValidation: ModellingAndValidation#: Covers the five sub-sections 1) LCI method, 2) Data sources, treatment and representativeness (not used for flows), 3) Completeness (not used for flows), 4) Validation (not used for flows), and 5) Compliance.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.flow_dataset.FlowInformation#

Bases: ElementBase

Covers the INvariable flow information addressed in ISO/TS 14048’s section “Inputs and outputs”

property dataSetInformation: DataSetInformation#: General data set information. Covers the ISO/TS 14048 fields 1.2.1, 1.2.3, 1.2.4, 1.2.5, (1.2.6), (1.2.7),1.2.10.1, 1.2.10.2, 1.2.10.3, and references to 1.2.11 (Flow property) and 1.2.11.2 (Unit).

property geography: Geography#: Provides information about the geographical representativeness of the data set.

property quantitativeReference: QuantitativeReference#: This section names the type of quantitative reference used for this Flow data set, which is always one of the Flow’s Flow properties (see section “Flow properties”).

property technology: Technology#: Provides information about the technological representativeness of the flow in case it is a product or waste flow.

class pyilcd.flow_dataset.FlowProperties#

Bases: ElementBase

List of flow properties (with all variable information linked to that respective flow).

property flowProperties: List[FlowProperty]#: One flow property.

class pyilcd.flow_dataset.FlowProperty#

Bases: ElementBase

One flow property.

property dataDerivationTypeStatus#: Identifies the way by which the Flow property value was derived (e.g. measured, estimated etc.), respectively the status and relevancy of missing data.

property dataSetInternalID#

internal ID, used in the “Quantitative reference” section to identify the reference flow property.

Type:: Automated entry

property generalComment#: General comment on each single flow property (if necessary) referring to specifc data sources used, or for workflow purposes about status of “finalisation” of an entry etc.

property maximumValue#: Maximum value of this flow property in case uncertainty distribution is uniform or triangular.

property meanValue#: Value for the flow expressed in this flow property in relationship to the the value of the flow expressed in its reference flow property (see field “Reference to reference flow property” in the “Quantitative reference” section). [Notes and examples: If the product flow “Diesel” is expressed by default in “Mass” (= reference flow property) and “kg” (= corresponding reference unit), the value that would be stated here for an additional flow property e.g. “Net calorific value” would be “42.5”, as this flow property has the reference unit “MJ” and Diesel has a net calorific value of 42.5 MJ per 1 kg. It is recommended to report only significant digits of the value.]

property minimumValue#: Minimum value of this flow property in case uncertainty distribution is uniform or triangular.

property referenceToFlowPropertyDataSet: GlobalReference#: “Flow property data set.

property relativeStandardDeviation95In#: The resulting overall uncertainty of the calculated variable value considering uncertainty of measurements, modelling, appropriateness etc. [Notes: For log-normal distribution the square of the geometric standard deviation (SDg^2) is stated. Mean value times SDg^2 equals the 97.5% value (= Maximum value), Mean value divided by SDg^2 equals the 2.5% value (= Minimum value). For normal distribution the doubled standard deviation value (2*SD) is entered. Mean value plus 2*SD equals 97.5% value (= Maximum value), Mean value minus 2*SD equals 2.5% value (= Minimum value). This data field remains empty when uniform or triangular uncertainty distribution is applied.]

property uncertaintyDistributionType#: Defines the kind of uncertainty distribution that is valid for this particular object or parameter.

class pyilcd.flow_dataset.Geography#

Bases: ElementBase

Provides information about the geographical representativeness of the data set.

property locationOfSupply#: Only used for product or waste flows and only required for matrix-type databases. Location or region of supply / consumption or production of the good or service, or operation of the process. Note 1: Entry can be of type “two-letter ISO 3166 country code” for countries, “seven-letter regional codes” for regions or continents, or “market areas and market organisations”, as predefined for the ILCD. Also a name for e.g. a specific plant etc. can be given here (e.g. “FR, Lyon, XY Company, Z Site”; user defined). Note 2: The fact whether the entry refers to production or to consumption / supply has to be stated in the name-field “Mix and location types” e.g. as “Production mix”.]

class pyilcd.flow_dataset.LCIMethod#

Bases: ElementBase

LCI methodological modelling aspects.

property typeOfDataSet#: Names the basic type of the flow.

class pyilcd.flow_dataset.ModellingAndValidation#

Bases: ElementBase

Covers the five sub-sections 1) LCI method, 2) Data sources, treatment and representativeness (not used for flows), 3) Completeness (not used for flows), 4) Validation (not used for flows), and 5) Compliance.

property complianceDeclarations: ComplianceDeclarations#: Statements on compliance of several data set aspects with compliance requirements as defined by the referenced compliance system (e.g. an EPD scheme, handbook of a national or international data network such as the ILCD, etc.).

property lciMethod: LCIMethod#: LCI methodological modelling aspects.

class pyilcd.flow_dataset.Name#

Bases: ElementBase

General descriptive and specifying name of the flow.

property baseName#: General descriptive name of the elementary, waste or product flow, for the latter including it’s level of processing.

property flowProperties#: Further, quantitative specifying information on the (product or waste) flow, in technical term(s): qualifying constituent(s)-content and / or energy-content per unit etc. as appropriate. Separated by commata. (Note: non-qualifying flow properties, CAS No, Synonyms, Chemical formulas etc. are documented exclusively in the respective fields.)

property mixAndLocationTypes#: Specifying information on the good, service, or process whether being a production mix or consumption mix, location type of availability (such as e.g. “to consumer” or “at plant”). Separated by commata.

property treatmentStandardsRoutes#: Specifying information on the (product or waste) flow in technical term(s): treatment received, standard fulfilled, product quality, use information, production route name, educt name, primary / secondary etc. Separated by commata..

class pyilcd.flow_dataset.PublicationAndOwnership#

Bases: PublicationAndOwnershipGroup1

Information related to publication and version management of the data set including copyright and access restrictions.

property referenceToOwnershipOfDataSet: GlobalReference#: “Contact data set” of the person or entity who owns this data set. (Note: this is not necessarily the publisher of the data set.)

class pyilcd.flow_dataset.QuantitativeReference#

Bases: ElementBase

This section names the type of quantitative reference used for this Flow data set, which is always one of the Flow’s Flow properties (see section “Flow properties”).

property referenceToReferenceFlowProperty#: One of the Flow’s Flow properties, which is set as the default flow property in which the flow measured. (Data set internal reference to one of the flow properties in section “Quantitative flow properties”.)

class pyilcd.flow_dataset.Technology#

Bases: ElementBase

Provides information about the technological representativeness of the flow in case it is a product or waste flow.

property referenceToTechnicalSpecification: List[GlobalReference]#: “Source data set(s)” of the product’s or waste’s technical specification, waste data sheet, safety data sheet, etc.

property technologicalApplicability#: Description of the intended / possible applications of the good or service, or waste. E.g. for which type of products the material, represented by this data set, is used. Examples: “This high purity chemical is used for analytical laboratories only.” or “This technical quality bulk chemical is used for large scale synthesis in chemical industry.”. Or: “This type of biowaste is typically composted or biodigested as the water content is too high for efficient combustion”.

pyilcd.flow_property_dataset module#

Custom ILCD Python classes for FlowDataSet of ILCD schema.

class pyilcd.flow_property_dataset.AdministrativeInformation#

Bases: ElementBase

Information on data set management and administration.

property dataEntryBy: DataEntryBy#: Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

property publicationAndOwnership: PublicationAndOwnership#: Information related to publication and version management of the data set including copyright and access restrictions.

class pyilcd.flow_property_dataset.DataEntryBy#

Bases: DataEntryByGroup1

Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

class pyilcd.flow_property_dataset.DataSetInformation#

Bases: ElementBase

General data set information.

property classificationInformation: ClassificationInformation#: Hierarchical classification of the good, service, or process. (Note: This entry is NOT required for the identification of a Process. It should nevertheless be avoided to use identical names for Processes in the same category.

property commonUUID#: Automatically generated Universally Unique Identifier of this data set. Together with the “Data set version”, the UUID uniquely identifies each data set.

property generalComments#: Free text for general information about the Flow data set. It may contain information about e.g. the use of the substance, good, service or process in a specific technology or industry-context, information sources used, data selection principles etc.

property names#: Name of flow property.

property synonyms#: Synonyms / alternative names / brands of the good, service, or process. Separated by semicolon.

class pyilcd.flow_property_dataset.DataSourcesTreatmentAndRepresentativeness#

Bases: ElementBase

Data sources, treatment and representativeness.

property referenceToDataSources: List[GlobalReference]#: “Source data set” of data source(s) used for the data set e.g. a paper, a questionnaire, a monography etc. The main raw data sources should be named, too. [Note: relevant especially for market price data.]

class pyilcd.flow_property_dataset.FlowPropertiesInformation#

Bases: ElementBase

Flow property information.

property dataSetInformation: DataSetInformation#: General data set information.

property quantitativeReference: QuantitativeReference#: This section allows to refer to the Flow property’s quantitative reference, which is always a unit (i.e. that unit, in which the property is measured, e.g. “MJ” for energy-related Flow properties).

class pyilcd.flow_property_dataset.FlowPropertyDataSet#

Bases: ElementBase

Flow Property Dataset.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property flowPropertiesInformation: FlowPropertiesInformation#: Flow property information.

property modellingAndValidation: ModellingAndValidation#: Covers the five sub-sections 1) LCI method (not used), 2) Data sources, treatment and representativeness (only 3 fields), 3) Completeness (not used), 4) Validation, and 5) Compliance.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.flow_property_dataset.ModellingAndValidation#

Bases: ElementBase

Covers the five sub-sections 1) LCI method (not used), 2) Data sources, treatment and representativeness (only 3 fields), 3) Completeness (not used), 4) Validation, and 5) Compliance.

property complianceDeclarations: ComplianceDeclarations#: Statements on compliance of several data set aspects with compliance requirements as defined by the referenced compliance system (e.g. an EPD scheme, handbook of a national or international data network such as the ILCD, etc.).

property dataSourcesTreatmentAndRepresentativeness: DataSourcesTreatmentAndRepresentativeness#: Data sources, treatment and representativeness.

class pyilcd.flow_property_dataset.PublicationAndOwnership#

Bases: PublicationAndOwnershipGroup1

Information related to publication and version management of the data set including copyright and access restrictions.

property referenceToOwnershipOfDataSet: GlobalReference#: “Contact data set” of the person or entity who owns this ata set. (Note: this is not necessarily the publisher of the ata set.)

class pyilcd.flow_property_dataset.QuantitativeReference#

Bases: ElementBase

This section allows to refer to the Flow property’s quantitative reference, which is always a unit (i.e. that unit, in which the property is measured, e.g. “MJ” for energy-related Flow properties).

property referenceToReferenceUnitGroup: GlobalReference#: “Unit group data set” and its reference unit, in which the Flow property is measured.

pyilcd.helpers module#

Internal helper classes.

pyilcd.helpers.create_attribute_contact_dataset(name, attr_type, validator=None)#

Helper wrapper method for creating setters and getters for an ilcd Contact Dataset attribute

Parameters:

name (str) –
attr_type (type) –
validator (Callable | None) –

Return type:

property

pyilcd.helpers.create_attribute_flow_dataset(name, attr_type, validator=None)#

Helper wrapper method for creating setters and getters for an ilcd Flow Dataset attribute

Parameters:

name (str) –
attr_type (type) –
validator (Callable | None) –

Return type:

property

pyilcd.helpers.create_attribute_flow_property_dataset(name, attr_type, validator=None)#

Helper wrapper method for creating setters and getters for an ilcd Flow Property Dataset attribute

Parameters:

name (str) –
attr_type (type) –
validator (Callable | None) –

Return type:

property

pyilcd.helpers.create_attribute_list_contact_dataset(name, attr_type)#

Helper wrapper method for creating setters and getters for an ilcd Contact Dataset element text list

Parameters:

name (str) –
attr_type (type) –

Return type:

property

pyilcd.helpers.create_attribute_list_flow_dataset(name, attr_type)#

Helper wrapper method for creating setters and getters for an ilcd Flow Dataset element text list

Parameters:

name (str) –
attr_type (type) –

Return type:

property

pyilcd.helpers.create_attribute_list_flow_property_dataset(name, attr_type)#

Helper wrapper method for creating setters and getters for an ilcd Flow Property Dataset element text list

Parameters:

name (str) –
attr_type (type) –

Return type:

property

pyilcd.helpers.create_attribute_list_process_dataset(name, attr_type)#

Helper wrapper method for creating setters and getters for an ilcd Process Dataset element text list

Parameters:

name (str) –
attr_type (type) –

Return type:

property

pyilcd.helpers.create_attribute_list_source_dataset(name, attr_type)#

Helper wrapper method for creating setters and getters for an ilcd Source Dataset element text list

Parameters:

name (str) –
attr_type (type) –

Return type:

property

pyilcd.helpers.create_attribute_list_unit_group_dataset(name, attr_type)#

Helper wrapper method for creating setters and getters for an ilcd Unit Group Dataset element text list

Parameters:

name (str) –
attr_type (type) –

Return type:

property

pyilcd.helpers.create_attribute_process_dataset(name, attr_type, validator=None)#

Helper wrapper method for creating setters and getters for an ilcd Process Dataset attribute

Parameters:

name (str) –
attr_type (type) –
validator (Callable | None) –

Return type:

property

pyilcd.helpers.create_attribute_source_dataset(name, attr_type, validator=None)#

Helper wrapper method for creating setters and getters for an ilcd Source Dataset attribute

Parameters:

name (str) –
attr_type (type) –
validator (Callable | None) –

Return type:

property

pyilcd.helpers.create_attribute_unit_group_dataset(name, attr_type, validator=None)#

Helper wrapper method for creating setters and getters for an ilcd Unit Group Dataset attribute

Parameters:

name (str) –
attr_type (type) –
validator (Callable | None) –

Return type:

property

pyilcd.helpers.create_element_text_contact_dataset(name, element_type)#

Helper wrapper method for creating setters and getters for an ilcd Contact element text

Parameters:

name (str) –
element_type (type) –

Return type:

property

pyilcd.helpers.create_element_text_flow_dataset(name, element_type)#

Helper wrapper method for creating setters and getters for an ilcd Flow Dataset element text

Parameters:

name (str) –
element_type (type) –

Return type:

property

pyilcd.helpers.create_element_text_process_dataset(name, element_type)#

Helper wrapper method for creating setters and getters for an ilcd Process Dataset element text

Parameters:

name (str) –
element_type (type) –

Return type:

property

pyilcd.helpers.create_element_text_unit_group_dataset(name, element_type)#

Helper wrapper method for creating setters and getters for an ilcd Unit Group element text

Parameters:

name (str) –
element_type (type) –

Return type:

property

pyilcd.process_dataset module#

Custom ILCD Python classes for ProcessDataSet of ILCD schema.

class pyilcd.process_dataset.AdministrativeInformation#

Bases: ElementBase

Information on data set management and administration.

property commissionerAndGoal: CommissionerAndGoal#: Basic information about goal and scope of the data set.

property dataEntryBy: DataEntryBy#: Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

property dataGenerator: DataGenerator#: Expert(s), that compiled and modelled the data set as well as internal administrative information linked to the data generation activity.

property publicationAndOwnership: PublicationAndOwnership#: Information related to publication and version management of the data set including copyright and access restrictions.

class pyilcd.process_dataset.Allocation#

Bases: ElementBase

Specifies one allocation of this exchange (see the attributes of this tag below)

property allocatedFraction#: Fraction (expressed in %) of this Input or Output flow that is foreseen to be allocated to this co-product (recommended allocation). The numbers across the co-products should sum up to 100%.

property internalReferenceToCoProduct#: Reference to one of the co-products. The applied allocation approach(es), details and and explanations are documented in the fields “LCI method approaches” and “Deviations from LCI method approaches / explanations”. [Notes: Applicable only to multifunctional processes. The documented allocated fractions are only applicable when using the data set for attributional modelling and are to be ignored for consequential modeling.]

class pyilcd.process_dataset.Allocations#

Bases: ElementBase

Container tag for the specification of allocations if process has more than one reference product. Use only for multifunctional processes.

property allocations: List[Allocation]#: Specifies one allocation of this exchange (see the attributes of this tag below)

class pyilcd.process_dataset.ComplementingProcesses#

Bases: ElementBase

Process data set(s)” that complement this partial / sub-set of a complete process data set, if any and available as separate data set(s). The identifying name of this sub-set should be stated in the field “Identifier of sub-data set”.

property referenceToComplementingProcesses: List[GlobalReference]#: Reference to one complementing process

class pyilcd.process_dataset.Completeness#

Bases: ElementBase

Data completeness aspects for this specific data set.

property completenessElementaryFlows: List[CompletenessElementaryFlows]#: “Completeness of the elementary flows in the Inputs and Outputs section of this data set from impact perspective, regarding addressing the individual mid-point problem field / impact category given. The completeness refers to the state-of-the-art of scientific knowledge whether or not an individual elementary flow contributes to the respective mid-point topic in a relevant way, which is e.g. the basis for the ILCD reference elementary flows. [Note: The “Completeness” statement does not automatically mean that related LCIA methods exist or reference the elementary flows of this data set. Hence for direct applicability of existing LCIA methods, check the field “Supported LCIA method data sets”.]

property completenessOtherProblemField#: Completeness of coverage of elementary flows that contribute to other problem fields that are named here as free text, preferably using the same terminology as for the specified environmental problems.

property completenessProductModel#: Completeness of coverage of relevant product, waste and elementary flows. [Notes: For LCI results and Partly terminated systems this means throughout the underlying product system model. “Relevant” refers to the overall environmental relevance, i.e. for unit processes including the upstream and downstream burdens of product and waste flows.]

property referenceToSupportedImpactAssessmentMethods: GlobalReference#: “LCIA methods data sets” that can be applied to the elementary flows in the Inputs and Outputs section, i.e. ALL these flows are referenced by the respective LCIA method data set (if they are of environmental relevance and a characterisation factor is defined for the respective flow). [Note: Applicability is not given if the inventoty contains some elementary flows with the same meaning as referenced in the LCIA method data set but in a different nomenclature (and hence carry no characterisation factor), or if the flows are sum indicators or flow groups that are addressed differently in the LCIA method data set.]

class pyilcd.process_dataset.CompletenessElementaryFlows#

Bases: ElementBase

Completeness of the elementary flows in the Inputs and Outputs section of this data set from impact perspective, regarding addressing the individual mid-point problem field / impact category given. The completeness refers to the state-of-the-art of scientific knowledge whether or not an individual elementary flow contributes to the respective mid-point topic in a relevant way, which is e.g. the basis for the ILCD reference elementary flows. [Note: The “Completeness” statement does not automatically mean that related LCIA methods exist or reference the elementary flows of this data set. Hence for direct applicability of existing LCIA methods, check the field “Supported LCIA method data sets”.]

property type#: Impact category for which the completeness information is stated.

property value#: Completeness value for the given impact category.

class pyilcd.process_dataset.Compliance#

Bases: ComplianceGroup

One compliance declaration

property documentationCompliance#: Documentation/Reporting compliance of this data set with the respective requirements set by the “compliance system” refered to.

property methodologicalCompliance#: Methodological compliance of this data set with the respective requirements set by the “compliance system” refered to.

property nomenclatureCompliance#: Nomenclature compliance of this data set with the respective requirements set by the “compliance system” refered to.

property qualityCompliance#: Quality compliance of this data set with the respective requirements set by the “compliance system” refered to.

property reviewCompliance#: Review/Verification compliance of this data set with the respective requirements set by the “compliance system” refered to.

class pyilcd.process_dataset.ComplianceDeclarations#

Bases: ElementBase

property compliances: List[Compliance]#: One compliance declaration

class pyilcd.process_dataset.DataEntryBy#

Bases: DataEntryByGroup1, DataEntryByGroup2

Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

property referenceToConvertedOriginalDataSetFrom: GlobalReference#: “Source data set” of the database or data set publication from which this data set has been obtained by conversion. This can cover e.g. conversion to a different format, applying a different nomenclature, mapping of flow names, conversion of units, etc. This may however not have changed or re-modeled the Inputs and Outputs, i.e. obtaining the same LCIA results. This entry is required for converted data sets stemming originally from other LCA databases (e.g. when re-publishing data from IISI, ILCD etc. databases). [Note: Identically re-published data sets are identied in the field “Unchanged re-publication of:” in the section “Publication and Ownership”.]

property referenceToDataSetUseApproval: List[GlobalReference]#

Names exclusively the producer or operator of the good, service or technology represented by this data set, which officially has approved this data set in all its parts. In case of nationally or internationally averaged data sets, this will be the respective business association. If no official approval has been given, the entry “No official approval by producer or operator” is to be entered and the reference will point to an empty “Contact data set”. [Notes: The producer or operator may only be named here, if a written approval of this data set was given. A recognition of this data set by any other organisation then the producer/operator of the good, service, or process is not to be stated here, but as a “review” in the validation section.]

Type:: “Source data set”

class pyilcd.process_dataset.DataGenerator#

Bases: ElementBase

Expert(s), that compiled and modelled the data set as well as internal administrative information linked to the data generation activity.

property referenceToPersonOrEntityGeneratingTheDataSet: List[GlobalReference]#: “Contact data set” of the person(s), working group(s), organisation(s) or database network, that generated the data set, i.e. being responsible for its correctness regarding methods, inventory, and documentative information.

class pyilcd.process_dataset.DataSetInformation#

Bases: ElementBase

General data set information. Section covers all single fields in the ISO/TS 14048 “Process description”, which are not part of the other sub-sections. In ISO/TS 14048 no own sub-section is foreseen for these entries.

property classificationInformation: FlowCategoryInformation#: Hierarchical classification of the good, service, or process. (Note: This entry is NOT required for the identification of a Process. It should nevertheless be avoided to use identical names for Processes in the same category.

property commonUUID#: Automatically generated Universally Unique Identifier of this data set. Together with the “Data set version”, the UUID uniquely identifies each data set.

property complementingProcesses: ComplementingProcesses#: Process data set(s)” that complement this partial / sub-set of a complete process data set, if any and available as separate data set(s). The identifying name of this sub-set should be stated in the field “Identifier of sub-data set”.

property generalComments#: General information about the data set, including e.g. general (internal, not reviewed) quality statements as well as information sources used. (Note: Please also check the more specific fields e.g. on “Intended application”, “Advice on data set use” and the fields in the “Modelling and validation” section to avoid overlapping entries.)

property identifierOfSubDataSet#: Identifier of a sub-set of a complete process data set. This can be the life cycle stage that a data set covers (such as used in EPDs for modular LCI reporting, with the inventory split up into “resource extraction stage”, “production stage”, “use stage” and “end-of-life stage”). Or it can be e.g. the type of emission source from which the elementary flows of the Inputs and Outputs stems (e.g. “incineration-related”, “transport-related”, etc.). Together with the field “Complementing processes” this allows to split up a process data set into a number of clearly identified data sets, each carrying only a part of the inventory and that together represent the complete inventory. Care has to be taken when naming the reference flow, to avoid misinterpretation..

property name: Name#: General descriptive and specifying name of the process.

property referenceToExternalDocumentation: GlobalReference#: “Source data set(s)” of detailed LCA study on the process or product represented by this data set, as well as documents / files with overarching documentative information on technology, geographical and / or time aspects etc. (e.g. basic engineering studies, process simulation results, patents, plant documentation, model behind the parameterisation of the “Mathematical model” section, etc.) (Note: can indirectly reference to digital file.)

property synonyms#: Synonyms / alternative names / brands of the good, service, or process. Separated by semicolon.

class pyilcd.process_dataset.DataSourcesTreatmentAndRepresentativeness#

Bases: ElementBase

Data selection, completeness, and treatment principles and procedures, data sources and market coverage information.

property annualSupplyOrProductionVolume#: Supply / consumption or production volume of the specific good, service, or technology in the region/market of the stated “Location”. The market volume is given in absolute numbers per year, in common units, for the stated “Reference year”. For multi-fucntional processes the data should be given for all co-functions (good and services).

property dataCollectionPeriod#: Date(s) or time period(s) when the data was collected. Note that this does NOT refer to e.g. the publication dates of papers or books from which the data may stem, but to the original data collection period.

property dataCutOffAndCompletenessPrinciples#: Principles applied in data collection regarding completeness of (also intermediate) product and waste flows and of elementary flows. Examples are: cut-off rules, systematic exclusion of infrastructure, services or auxiliaries, etc. systematic exclusion of air in incineration processes, coling water, etc.

property dataSelectionAndCombinationPrinciples#: Principles applied in data selection and in combination of data from different sources. Includes brief discussion of consistency of data sources regarding data itself, modelling, appropriateness. In case of averaging: Principles and data selection applied in horizontal and / or vertical averaging.

property dataTreatmentAndExtrapolationsPrinciples#: Principles applied regarding methods, sources, and assumptions done in data adjustment including extrapolations of data from another time period, another geographical area, or another technology.

property deviationsFromCutOffAndCompletenessPrinciples#: Short description of any deviations from the “Data completeness principles”. In case of no (result relevant) deviations, “none” is entered.

property deviationsFromSelectionAndCombinationPrinciples#: Short description of any deviations from the “Data selection and combination principles”. In case of no (result relevant) deviations, “none” is entered.

property deviationsFromTreatmentAndExtrapolationPrinciples#: Short description of any deviations from the “ Data treatment and extrapolations principles”. In case of no (result relevant) deviations, “none” is entered. (Note: If data representative for one “Location” is used for another “Location”, its original representativity can be indicated here; see field “Percentage supply or production covered”.)

property percentageSupplyOrProductionCovered#: Percentage of the overall supply, consumption, or production of the specific good, service, or technology represented by this data set, in the region/market of the stated “Location”. For multi-functional processes the market share of the specific technology is stated. If data that is representative for a process operated in one “Location” is used for another “Location”, the entry is ‘0’. The representativity for the original “Location” is documented in the field “Deviation from data treatment and extrapolation principles, explanations”.

property referenceToDataHandlingPrinciples: List[GlobalReference]#: “Source data set”(s) of the source(s) in which the data completeness, selection, combination, treatment, and extrapolations principles’ details are described

property referenceToDataSource: List[GlobalReference]#: “Source data set”(s) of the source(s) used for deriving/compiling the inventory of this data set e.g. questionnaires, monographies, plant operation protocols, etc. For LCI results and Partly terminated systems the sources for relevant background system data are to be given, too. For parameterised data sets the sources used for the parameterisation / mathematical relations in the section “Mathematical model” are referenced here as well. [Note: If the data set stems from another database or data set publication and is only re-published: identify the origin of a converted data set in “Converted original data set from:” field in section “Data entry by” and its unchanged re-publication in “Unchanged re-publication of:” in the section “Publication and ownership”. The data sources used to model a converted or re-published data set are nevertheless to be given here in this field, for transparency reasons.]

property samplingProcedure#: Sampling procedure used for quantifying the amounts of Inputs and Outputs. Possible problems in combining different sampling procedures should be mentioned.

property uncertaintyAdjustments#: Description of methods, sources, and assumptions made in uncertainty adjustment. [Note: For data sets where the additional uncertainty due to lacking representativeness has been included in the quantified uncertainty values, this field also reports the original representativeness, the additional uncertainty, and the procedure by which the overall uncertainty was assessed or calculated.]

property useAdviceForDataSet#: Specific methodological advice for data set users that requires attention. E.g. on inclusion/exclusion of recycling e.g. in material data sets, specific use phase behavior to be modelled, and other methodological advices. See also field “Technological applicability”.

class pyilcd.process_dataset.Exchange#

Bases: ElementBase

Input/Output list of exchanges with the quantitative inventory data as well as pre-calculated LCIA results.

property allocations: Allocations#: “Container tag for the specification of allocations if process has more than one reference product. Use only for multifunctional processes.

property dataDerivationTypeStatus#: Identifies the way by which the individual Input / Output amount was derived (e.g. measured, estimated etc.), respectively the status and relevancy of missing data.

property dataSetInternalID#

internal ID, used in the “Quantitative reference” section to identify the “Reference flow(s)” in case the quantitative reference of this Process data set is of this type.

Type:: Automated entry

property dataSourceType#: Identifies the data source type of each single Input or Output as being “Primary”, “Secondary”, or “Mixed primary/secondary”.

property exchangeDirection#: Direction of Input or Output flow.

property functionType#

property generalComment#: General comment on this specific Input or Output, e.g. commenting on the data sources used and their specific representatuveness etc., on the status of “finalisation” of an entry as workflow information, etc.

property location#: Location where exchange of elementary flow occurs. Used only for those LCIA methods, that make use of this information. This information refers to the entry within the same field in the “Inputs and Outpts” section of the “Process or LCI result data set”.

property maximumAmount#: Maximum amount of the Input or Output in case the uncertainty distribution is uniform or triangular. In case of calculated LCI results and for the aggregated flows in Partly terminated system data sets, the upper end of the 95% likelihood range, i.e. the “97.5% value” can be reported in this field.

property meanAmount#: Mean amount of the Input or Output. Only significant digits of the amount should be stated.

property minimumAmount#: Minimum amount of the Input or Output in case the uncertainty distribution is uniform or triangular. In case of calculated LCI results and for the aggregated flows in Partly terminated system data sets, the lower end of the 95% likelihood range, i.e. the “2.5% value” can be reported in this field.

property referenceToFlowDataSet: GlobalReference#: “Flow data set” of this Input or Output.

property referenceToVariable#: Data set internal reference to a variable or parameter name as defined in the section “Mathematical model”. The value of this variable or parameter acts as linear multiplier to the value given in the field “Mean amount” to yield the “Resulting amount”, which is the final value in the inventory.

property referencesToDataSource: ReferencesToDataSource#: “Source data set” of data source(s) used for the value of this specific Input or Output, especially if differing from the general data source used for this data set.

property relativeStandardDeviation95In#: The resulting overall uncertainty of the calculated variable value considering uncertainty of measurements, modelling, appropriateness etc. [Notes: For log-normal distribution the square of the geometric standard deviation (SDg^2) is stated. Mean value times SDg^2 equals the 97.5% value (= Maximum value), Mean value divided by SDg^2 equals the 2.5% value (= Minimum value). For normal distribution the doubled standard deviation value (2*SD) is entered. Mean value plus 2*SD equals 97.5% value (= Maximum value), Mean value minus 2*SD equals 2.5% value (= Minimum value). This data field remains empty when uniform or triangular uncertainty distribution is applied.]

property resultingAmount#: Final value to be used for calculation of the LCI results and in the product system: It is calculated as the product of the “Mean amount” value times the value of the “Variable”. In case that no “Variable” entry is given, the “Resulting amount” is identical to the “Mean amount”, i.e. a factor “1” is applied.

property uncertaintyDistributionType#: Defines the kind of uncertainty distribution that is valid for this particular object or parameter.

class pyilcd.process_dataset.Exchanges#

Bases: ElementBase

Input/Output list of exchanges with the quantitative inventory data, as well as pre-calculated LCIA results.

property exchanges: List[Exchange]#: Input/Output list of exchanges with the quantitative inventory data as well as pre-calculated LCIA results.

class pyilcd.process_dataset.Geography#

Bases: ElementBase

Provides information about the geographical representativeness of the dataset.

property locationOfOperationSupplyOrProduction: LocationOfOperationSupplyOrProduction#

This field does not refer to e.g. the country in which a specific site is located that is represented by this data set but to the actually represented country, region, or site. Note 2: Entry can be of type “two-letter ISO 3166 country code” for countries, “seven-letter regional codes” for regions or continents, or “market areas and market organisations”, as predefined for the ILCD. Also a name for e.g. a specific plant etc. can be given here (e.g. “FR, Lyon, XY Company, Z Site”; user defined). Note 3: The fact whether the entry refers to production or to consumption / supply has to be stated in the name-field “Mix and location types” e.g. as “Production mix”.]

Type:: Location, country or region the data set represents. [Note 1

property subLocationOfOperationSupplyOrProduction: List[SubLocationOfOperationSupplyOrProduction]#: One or more geographical sub-unit(s) of the stated “Location”. Such sub-units can be e.g. the sampling sites of a company-average data set, the countries of a region-average data set, or specific sites in a country-average data set. [Note: For single site data sets this field is empty and the site is named in the “Location” field.]

class pyilcd.process_dataset.LCIAResult#

Bases: ElementBase

Single LCIA result

property commonGeneralComment#: General comment on this specific LCIA result, e.g. commenting on the correspondence of the inputs and outputs with the applied LCIA method etc.

property meanAmount#: Mean amount of the LCIA result of the inventory, calculated for this LCIA method. Only significant digits should be stated.

property referenceToLCIAMethodDataSets: GlobalReference#: “LCIA method data set” applied to calculate the LCIA results.

property relativeStandardDeviation95In#: The resulting overall uncertainty of the calculated variable value considering uncertainty of measurements, modelling, appropriateness etc. [Notes: For log-normal distribution the square of the geometric standard deviation (SDg^2) is stated. Mean value times SDg^2 equals the 97.5% value (= Maximum value), Mean value divided by SDg^2 equals the 2.5% value (= Minimum value). For normal distribution the doubled standard deviation value (2*SD) is entered. Mean value plus 2*SD equals 97.5% value (= Maximum value), Mean value minus 2*SD equals 2.5% value (= Minimum value). This data field remains empty when uniform or triangular uncertainty distribution is applied.]

property uncertaintyDistributionType#: Defines the kind of uncertainty distribution that is valid for this LCIA result.

class pyilcd.process_dataset.LCIAResults#

Bases: ElementBase

List with the pre-calculated LCIA results of the Input/Output list of this data set. May contain also inventory-type results such as primary energy consumption etc.

property lciaResults: List[LCIAResult]#: Single LCIA result

class pyilcd.process_dataset.LCIMethodAndAllocation#

Bases: ElementBase

LCI methodological modelling aspects including allocation / substitution information.

property LCIMethodApproaches#: Names briefly the specific approach(es) used in LCI modeling, e.g. allocation, substitution etc. In case of LCI results and Partly terminated system data sets this also covers those applied in the included background system.

property LCIMethodPrinciple#: LCI method principle followed in the product system modelling, i.e. regarding using average data (= attributional = non-marginal) or modelling effects in a change-oriented way (= consequential = marginal).

property deviationsFromLCIMethodApproaches#: Description of relevant deviations from the applied approaches as well as of the relevant specific approaches that were applied, including in an possibly included background system. Further explanations and details of the allocation, substitution and other consequential approaches applied for relevant processes, e.g. how the marginal substitute was identified, year and region of which market prices were used in market allocation, i.e. method, procedure, data/information details. In case of no (result relevant) deviations from the before stated LCI method approaches, and in case of no need for further explanations, “none” is entered.

property deviationsFromLCIMethodPrinciple#: Short description of any deviations from the general “LCI method principles” and additional explanations. Refers especially to specific processes/cases where the stated “attributional” or “consequential” approach was not applied. Or where deviations were made from any specific rules for applying the “Consequential with attributional components” approach. A reference to the “Intended application” of the data collection can be made here, too. Allocated co-products may be reported here as well. In case of no (quantitatively relevant) deviations from the LCI method principle, “none” should be stated.

property deviationsFromModellingConstants#: Short description of data set specific deviations from the “Modelling constants” if any, including in the possibly included background system.

property modellingConstants#: Short identification and description of constants applied in LCI modelling other than allocation / substitution, e.g. systematic setting of recycling quota, use of gross or net calorific value, etc.

property referenceToLCAMethodDetails: List[GlobalReference]#: “Source data set”(s) where the generally used LCA methods including the LCI method principles and specific approaches, the modelling constants details, as well as any other applied methodological conventions are described.

property typeOfDataSet#: Type of the data set regarding systematic inclusion/exclusion of upstream or downstream processes, transparency and internal (hidden) multi-functionality, and the completeness of modelling.

class pyilcd.process_dataset.LocationOfOperationSupplyOrProduction#

Bases: ElementBase

Location, country or region the data set represents. [Note 1: This field does not refer to e.g. the country in which a specific site is located that is represented by this data set but to the actually represented country, region, or site. Note 2: Entry can be of type “two-letter ISO 3166 country code” for countries, “seven-letter regional codes” for regions or continents, or “market areas and market organisations”, as predefined for the ILCD. Also a name for e.g. a specific plant etc. can be given here (e.g. “FR, Lyon, XY Company, Z Site”; user defined). Note 3: The fact whether the entry refers to production or to consumption / supply has to be stated in the name-field “Mix and location types” e.g. as “Production mix”.]

property descriptionOfRestrictions#

e.g. a company and/or site description and address, whether for certain sub-areas within the “Location” the data set is not valid, whether data is only valid for certain regions within the location indicated, or whether certain elementary flows or intermediate product flows are extrapolated from another geographical area.

Type:: Further explanations about additional aspects of the location

property latitudeAndLongitude#: Geographical latitude and longitude reference of “Location” / “Sub-location”. For area-type locations (e.g. countries, continents) the field is empty.

property location#

Type:: Location, country or region the data set represents. [Note 1

class pyilcd.process_dataset.MathematicalRelations#

Bases: ElementBase

A set of formulas that allows to model the amount of single exchanges in the input and output list in dependency of each other and/or in dependency of parameters. Used to provide a process model (“parameterized process”) for calculation of inventories in dependency of user settings of e.g. yield, efficiency of abatement measures, processing of different educts, etc.

property modelDescription#: Description of the model(s) represented in this section of mathematical relations. Can cover information on restrictions, model strenghts and weaknesses, etc. (Note: Also see information provided on the level of the individual formula in field “Comment” and in the general process description in the fields in section “Technology”.)

property variableParameter: List[VariableParameter]#: Name of variable or parameter used as scaling factors for the “Mean amount” of individual inputs or outputs of the data set.

class pyilcd.process_dataset.ModellingAndValidation#

Bases: ElementBase

Covers the five sub-sections 1) LCI method and allocation, 2) Data sources, treatment and representativeness, 3) Completeness, 4) Validation, and 5) Compliance. (Section refers to LCI modelling and data treatment aspects etc., NOT the modeling of e.g. the input/output-relationships of a parameterised data set.)

property completeness: Completeness#: Data completeness aspects for this specific data set.

property complianceDeclarations: ComplianceDeclarations#: Statements on compliance of several data set aspects with compliance requirements as defined by the referenced compliance system (e.g. an EPD scheme, handbook of a national or international data network such as the ILCD, etc.).

property dataSourcesTreatmentAndRepresentativeness: DataSourcesTreatmentAndRepresentativeness#: Data selection, completeness, and treatment principles and procedures, data sources and market coverage information.

property lciMethodAndAllocation: LCIMethodAndAllocation#: LCI methodological modelling aspects including allocation / substitution information.

property validation: Validation#: Review / validation information on data set.

class pyilcd.process_dataset.Name#

Bases: ElementBase

General descriptive and specifying name of the process.

property baseName#: General descriptive name of the process and/or its main good(s) or service(s) and/or it’s level of processing.

property functionalUnitFlowProperties#: Further, quantitative specifying information on the good, service or process in technical term(s): qualifying constituent(s)-content and / or energy-content per unit etc. as appropriate. Separated by commata. (Note: non-qualifying flow properties, CAS No, Synonyms, Chemical formulas etc. are documented exclusively in the “Flow data set”.)

property mixAndLocationTypes#: Specifying information on the good, service, or process whether being a production mix or consumption mix, location type of availability (such as e.g. “to consumer” or “at plant”). Separated by commata.

property treatmentStandardsRoutes#: Specifying information on the good, service, or process in technical term(s): treatment received, standard fulfilled, product quality, use information, production route name, educt name, primary / secondary etc. Separated by commata.

class pyilcd.process_dataset.ProcessDataSet#

Bases: ElementBase

Data set for unit processes, partly terminated systems, and LCI results. May contain LCIA results as well.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property exchanges: Exchanges#: Input/Output list of exchanges with the quantitative inventory data, as well as pre-calculated LCIA results.

property lciaResults: LCIAResults#: List with the pre-calculated LCIA results of the Input/Output list of this data set. May contain also inventory-type results such as primary energy consumption etc.

property locations#: Contains reference to used location table for this dataset.

property metaDataOnly#: Indicates whether this data set contains only meta data (no exchanges section).

property modellingAndValidation: ModellingAndValidation#: Covers the five sub-sections 1) LCI method and allocation, 2) Data sources, treatment and representativeness, 3) Completeness, 4) Validation, and 5) Compliance. (Section refers to LCI modelling and data treatment aspects etc., NOT the modeling of e.g. the input/output-relationships of a parameterised data set.)

property processInformation: ProcessInformation#: Corresponds to the ISO/TS 14048 section “Process description”. It comprises the following six sub-sections: 1) “Data set information” for data set identification and overarching information items, 2) “Quantitative reference”, 3) “Time”, 4) “Geography”, 5) “Technology” and 6) “Mathematical relations”.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.process_dataset.ProcessInformation#

Bases: ElementBase

Corresponds to the ISO/TS 14048 section “Process description”. It comprises the following six sub-sections: 1) “Data set information” for data set identification and overarching information items, 2) “Quantitative reference”, 3) “Time”, 4) “Geography”, 5) “Technology” and 6) “Mathematical relations”.

property dataSetInformation: DataSetInformation#: General data set information. Section covers all single fields in the ISO/TS 14048 “Process description”, which are not part of the other sub-sections. In ISO/TS 14048 no own sub-section is foreseen for these entries.

property geography: Geography#: Provides information about the geographical representativeness of the dataset.

property mathematicalRelations: MathematicalRelations#: A set of formulas that allows to model the amount of single exchanges in the input and output list in dependency of each other and/or in dependency of parameters. Used to provide a process model (“parameterized process”) for calculation of inventories in dependency of user settings of e.g. yield, efficiency of abatement measures, processing of different educts, etc.

property quantitativeReference: QuantitativeReference#: This section names the quantitative reference used for this data set, i.e. the reference to which the inputs and outputs quantiatively relate.

property technology: Technology#: Provides information about the technological representativeness of the data set.

property time: Time#: Provides information about the time representativeness of the dataset.

class pyilcd.process_dataset.PublicationAndOwnership#

Bases: PublicationAndOwnershipGroup1, PublicationAndOwnershipGroup2, PublicationAndOwnershipGroup3

Information related to publication and version management of the data set including copyright and access restrictions.

property referenceToOwnershipOfDataSet: GlobalReference#: “”Contact data set” of the person or entity who owns this data set. (Note: this is not necessarily the publisher of the data set.)

property referenceToRegistrationAuthority: GlobalReference#: “Contact data set” of the authority that has registered this data set.

property registrationNumber#: A unique identifying number for this data set issued by the registration authority.

class pyilcd.process_dataset.QuantitativeReference#

Bases: ElementBase

This section names the quantitative reference used for this data set, i.e. the reference to which the inputs and outputs quantiatively relate.

property functionalUnitOrOther#: Quantity, name, property/quality, and measurement unit of the Functional unit, Production period, or Other parameter, in case “Type of quantitative reference” is of one of these types. [Note: One or more functional units can also be given in addition to a reference flow.]

property referenceToReferenceFlow#: One or more of the Inputs or Outputs in case “Type of quantitative reference” is of type “Reference flow(s)”. (Data set internal reference.)

property type#: Type of quantitative reference of this data set.

class pyilcd.process_dataset.ReferencesToDataSource#

Bases: ElementBase

“Source data set” of data source(s) used for the value of this specific Input or Output, especially if differing from the general data source used for this data set.

property referenceToDataSources: List[GlobalReference]#: “”Source data set” of data source(s) used for the value of this specific Input or Output, especially if differing from the general data source used for this data set.

class pyilcd.process_dataset.Review#

Bases: ValidationGroup1, ValidationGroup3

Review information on data set.

property type#: Type of review that has been performed regarding independency and type of review process.

class pyilcd.process_dataset.SubLocationOfOperationSupplyOrProduction#

Bases: ElementBase

One or more geographical sub-unit(s) of the stated “Location”. Such sub-units can be e.g. the sampling sites of a company-average data set, the countries of a region-average data set, or specific sites in a country-average data set. [Note: For single site data sets this field is empty and the site is named in the “Location” field.]

property descriptionOfRestrictions#

Type:: Further explanations about additional aspects of the location

property latitudeAndLongitude#: Geographical latitude and longitude reference of “Location” / “Sub-location”. For area-type locations (e.g. countries, continents) the field is empty.

property subLocation#: One or more geographical sub-unit(s) of the stated “Location”. Such sub-units can be e.g. the sampling sites of a company-average data set, the countries of a region-average data set, or specific sites in a country-average data set. [Note: For single site data sets this field is empty and the site is named in the “Location” field.]

class pyilcd.process_dataset.Technology#

Bases: ElementBase

Provides information about the technological representativeness of the dataset.

property referenceToIncludedProcesses: List[GlobalReference]#: “Process data set(s)” included in this data set, if any and available as separate data set(s).

property referenceToTechnologyFlowDiagrammOrPicture: List[GlobalReference]#: “Source data set” of the flow diagramm(s) and/or photo(s) of the good, service, technology, plant etc represented by this data set. For clearer illustration and documentation of data set.

property referenceToTechnologyPictogramme: GlobalReference#: “Source data set” of the pictogramme of the good, service, technogy, plant etc. represented by this data set. For use in graphical user interfaces of LCA software.

property technologicalApplicability#: Description of the intended / possible applications of the good, service, or process. E.g. for which type of products the material, represented by this data set, is used. Examples: “This high purity chemical is used for analytical laboratories only.” or “This technical quality bulk chemical is used for large scale synthesis in chemical industry.”. Or: “This truck is used only for long-distance transport of liquid bulk chemicals”.

property technologyDescriptionAndIncludedProcesses#: Description of the technological characteristics including operating conditions of the process or product system. For the latter this includes the relevant upstream and downstream processes included in the data set. Professional terminology should be used.

class pyilcd.process_dataset.Time#

Bases: ElementBase

Provides information about the time representativeness of the dataset.

property dataSetValidUntil#: End year of the time period for which the data set is still valid / sufficiently representative. This date also determines when a data set revision / remodelling is required or recommended due to expected relevant changes in environmentally or technically relevant inventory values, including in the background system.

property referenceYear#: Start year of the time period for which the data set is valid (until year of “Data set valid until:”). For data sets that combine data from different years, the most representative year is given regarding the overall environmental impact. In that case, the reference year is derived by expert judgement.

property timeRepresentativenessDescription#: Description of the valid time span of the data set including information on limited usability within sub-time spans (e.g. summer/winter).

class pyilcd.process_dataset.Validation#

Bases: ElementBase

Review / validation information on data set.

property reviews: List[Review]#: Review information on data set.

class pyilcd.process_dataset.VariableParameter#

Bases: ElementBase

Name of variable or parameter used as scaling factors for the “Mean amount” of individual inputs or outputs of the data set.

property comment#: Comment or description of variable or parameter. Typically including its unit and default values, e.g. in the pattern <[unit] description; defaults; comments>.

property formula#: Mathematical expression that determines the value of a variable. [Note: A parameter is defined by entering the value manually into the field “Mean value” and this field can be left empty.]

property maximumValue#: Maximum value permissible for this parameter. For variables this field is empty.

property meanValue#: Parameter value entered by user OR in case a formula is given in the “Formula” field, the result of the formula for the variable is displayed here.

property minimumValue#: Minimum value permissible for this parameter. For variables this field is empty

property name#: Name of variable or parameter used as scaling factors for the “Mean amount” of individual inputs or outputs of the data set.

property relativeStandardDeviation95In#: The resulting overall uncertainty of the calculated variable value considering uncertainty of measurements, modelling, appropriateness etc. [Notes: For log-normal distribution the square of the geometric standard deviation (SDg^2) is stated. Mean value times SDg^2 equals the 97.5% value (= Maximum value), Mean value divided by SDg^2 equals the 2.5% value (= Minimum value). For normal distribution the doubled standard deviation value (2*SD) is entered. Mean value plus 2*SD equals 97.5% value (= Maximum value), Mean value minus 2*SD equals 2.5% value (= Minimum value). This data field remains empty when uniform or triangular uncertainty distribution is applied.]

property uncertaintyDistributionType#: Defines the kind of uncertainty distribution that is valid for this particular object or parameter.

pyilcd.source_dataset module#

Custom ILCD Python classes for SourceDataSet of ILCD schema.

class pyilcd.source_dataset.AdministrativeInformation#

Bases: ElementBase

Information on data set management and administration.

property dataEntryBy: DataEntryBy#: Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

property publicationAndOwnership: PublicationAndOwnership#: Information related to publication and version management of the data set including copyright and access restrictions.

class pyilcd.source_dataset.DataEntryBy#

Bases: DataEntryByGroup1

Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

class pyilcd.source_dataset.DataSetInformation#

Bases: ElementBase

Data set information.

property classificationInformation: ClassificationInformation#: Hierachical classification of the Source foreseen to be used to structure the Source content of the database. (Note: This entry is NOT required for the identification of a Source. It should nevertheless be avoided to use identical names for Source in the same class.

property commonUUID#: Automatically generated Universally Unique Identifier of this data set. Together with the “Data set version”, the UUID uniquely identifies each data set.

property publicationType#: Bibliographic publication type of the source.

property referenceToContact: List[GlobalReference]#: “Contact data set”s of working groups, organisations or database networks to which EITHER this person or entity OR this database, data set format, or compliance system belongs. [Note: This does not necessarily imply a legally binding relationship, but may also be a voluntary membership.]

property referenceToDigitalFiles: List[ReferenceToDigitalFile]#: Link to a digital file of the source (www-address or intranet-path; relative or absolue path). (Info: Allows direct access to e.g. complete reports of further documentation, which may also be digitally attached to this data set and exchanged jointly with the XML file.)

property referenceToLogo: GlobalReference#: “Source data set” of the logo of the organisation or source to be used in reports etc.

property shortNames#: Short name for the “Source citation”, i.e. for the bibliographical reference or reference to internal data sources used.

property sourceCitation#: Bibliographical reference or reference to internal data source. Also used in order to reference to databases and tools, data set formats, conformity systems, pictures etc..

property sourceDescriptionOrComments#: Free text for additional description of the source. In case of use of published data it may contain a brief summary of the publication and the kind of medium used (e.g. CD-ROM, hard copy).

class pyilcd.source_dataset.PublicationAndOwnership#

Bases: PublicationAndOwnershipGroup1

Information related to publication and version management of the data set including copyright and access restrictions.

property referenceToOwnershipOfDataSet: GlobalReference#: “Contact data set” of the person or entity who owns this ata set. (Note: this is not necessarily the publisher of the ata set.)

class pyilcd.source_dataset.ReferenceToDigitalFile#

Bases: ElementBase

Link to a digital file of the source (www-address or intranet-path; relative or absolue path). (Info: Allows direct access to e.g. complete reports of further documentation, which may also be digitally attached to this data set and exchanged jointly with the XML file.)

property uri#: URI for digital file.

class pyilcd.source_dataset.SourceDataSet#

Bases: ElementBase

Data set for bibliographical references to sources used, but also for reference to data set formats, databases, conformity systems etc.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property sourceInformation: SourceInformation#: Source information.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.source_dataset.SourceInformation#

Bases: ElementBase

Source information.

property dataSetInformation: DataSetInformation#: General data set information.

pyilcd.unit_group_dataset module#

Custom ILCD Python classes for UnitGroupDataSet of ILCD schema.

class pyilcd.unit_group_dataset.AdministrativeInformation#

Bases: ElementBase

Information on data set management and administration.

property dataEntryBy: DataEntryBy#: Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

property publicationAndOwnership: PublicationAndOwnership#: Information related to publication and version management of the data set including copyright and access restrictions.

class pyilcd.unit_group_dataset.DataEntryBy#

Bases: DataEntryByGroup1

Staff or entity, that documented the generated data set, entering the information into the database; plus administrative information linked to the data entry activity.

class pyilcd.unit_group_dataset.DataSetInformation#

Bases: ElementBase

General data set information.

property classificationInformation: ClassificationInformation#: Hierarchical classification of the good, service, or process. (Note: This entry is NOT required for the identification of a Process. It should nevertheless be avoided to use identical names for Processes in the same category.

property commonUUID#: Automatically generated Universally Unique Identifier of this data set. Together with the “Data set version”, the UUID uniquely identifies each data set.

property generalComments#: Free text for general information about the Flow data set. It may contain information about e.g. the use of the substance, good, service or process in a specific technology or industry-context, information sources used, data selection principles etc.

property names#: Name of the unit group, typically indicating for which flow property or group of flow properties it is used. The individual units are named in the “Units” section of the “Unit group data set”.

property synonyms#: Synonyms / alternative names / brands of the good, service, or process. Separated by semicolon.

class pyilcd.unit_group_dataset.ModellingAndValidation#

Bases: ElementBase

Sections used to a very limited degree; covers the five sub-sections 1) LCI method and allocation (not used for unit groups), 2) Data sources, treatment and representativeness (not used for unit groups), 3) Completeness (not used for unit groups), 4) Validation (not used for unit groups), and 5) Compliance.

property complianceDeclarations: ComplianceDeclarations#: Statements on compliance of several data set aspects with compliance requirements as defined by the referenced compliance system (e.g. an EPD scheme, handbook of a national or international data network such as the ILCD, etc.).

class pyilcd.unit_group_dataset.PublicationAndOwnership#

Bases: PublicationAndOwnershipGroup1

Information related to publication and version management of the data set including copyright and access restrictions.

property referenceToOwnershipOfDataSet: GlobalReference#: “Contact data set” of the person or entity who owns this ata set. (Note: this is not necessarily the publisher of the ata set.)

class pyilcd.unit_group_dataset.QuantitativeReference#

Bases: ElementBase

This section identifies the quantitative reference of this data set, i.e. the “reference unit” in which the data set is expressed. It is the basis for the conversion to other units in the data set (e.g. for mass-related units “kg” as basis for conversion to and among “g”, “ounces”, “short tons”, etc.).

property referenceToReferenceUnit#: The Unit group’s unit in which the data set is expressed (data set internal reference).

class pyilcd.unit_group_dataset.Unit#

Bases: ElementBase

One unit.

property dataSetInternalID#

internal ID, used in the “Quantitative reference” section to identify the reference unit.

Type:: Automated entry

property generalComment#: General comment on each single unit, typically giving the long name and unit system from which this unit stems, and (if necessary) referring to specifc data sources used, or for workflow purposes about status of “finalisation” of an entry etc.

property meanValue#: Mean value of this unit in relationship to the reference unit of this Unit group (see field “Reference unit” in the “Quantitative reference” section). [Notes and Examples: This vale is i.e. the linear conversion factor for this unit. E.g., if the Unit group would be “Units of mass” and the selected reference unit “kg”, then the value stated here for an additional unit “g” would be 0.001, as 1 g is 0.001 times 1 kg. It is recommended to report only significant digits of the value.]

class pyilcd.unit_group_dataset.UnitGroupDataSet#

Bases: ElementBase

Unit Group Dataset.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property modellingAndValidation: ModellingAndValidation#: Sections used to a very limited degree; covers the five sub-sections 1) LCI method and allocation (not used for unit groups), 2) Data sources, treatment and representativeness (not used for unit groups), 3) Completeness (not used for unit groups), 4) Validation (not used for unit groups), and 5) Compliance.

property unitGroupInformation: UnitGroupInformation#: Unit group information.

property units: Units#: List of units that belong to this Unit group and are interconvertible among each other with a fixed factor, such as this can be done e.g. for kg, g, ounces, pounds etc. of the Unit group “Units of mass”.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.unit_group_dataset.UnitGroupInformation#

Bases: ElementBase

Unit group information.

property dataSetInformation: DataSetInformation#: General data set information.

property quantitativeReference: QuantitativeReference#: This section identifies the quantitative reference of this data set, i.e. the “reference unit” in which the data set is expressed. It is the basis for the conversion to other units in the data set (e.g. for mass-related units “kg” as basis for conversion to and among “g”, “ounces”, “short tons”, etc.).

class pyilcd.unit_group_dataset.Units#

Bases: ElementBase

Unit group information.

property units: List[Unit]#: One unit.

pyilcd.utils module#

Utilities module for pyilcd.

pyilcd.utils.get_version_tuple()#

Returns version as (major, minor, micro).

Return type:: tuple

Module contents#

pyilcd.

class pyilcd.ContactDataSet#

Bases: ElementBase

Contact Dataset.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property contactInformation: ContactInformation#: Contact information,

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.Defaults#

Bases: object

Stores default values for ILCD attributes used when no value exists.

DYNAMIC_DEFAULTS: ClassVar[Dict[str, Dict[str, Callable[[ElementBase], str]]]] = {}#

SCHEMA_CONTACT_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_ContactDataSet.xsd'#

SCHEMA_DIR: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas'#

SCHEMA_FLOW_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_FlowDataSet.xsd'#

SCHEMA_FLOW_PROPERTY_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_FlowPropertyDataSet.xsd'#

SCHEMA_PROCESS_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_ProcessDataSet.xsd'#

SCHEMA_SOURCE_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_SourceDataSet.xsd'#

SCHEMA_UNIT_GROUP_DATASET: ClassVar[str] = '/home/docs/checkouts/readthedocs.org/user_builds/pyilcd/envs/stable/lib/python3.10/site-packages/pyilcd/schemas/ILCD_UnitGroupDataSet.xsd'#

STATIC_DEFAULTS: ClassVar[Dict[str, Dict[str, str]]] = {'Classification': {'name': 'ILCD'}, 'FlowCategorization': {'name': 'ILCD'}, 'ProcessDataset': {'metaDataOnly': 'false'}}#

classmethod config_defaults(config_file)#

Fully/ partially overrides defaults. Parameters: config_file: path for config file.

Parameters:: config_file (str) –
Return type:: None

class pyilcd.FlowDataSet#

Bases: ElementBase

Covers the INvariable flow information addressed in ISO/TS 14048’s section “Inputs and outputs”

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property flowInformation: FlowInformation#: Covers the INvariable flow information addressed in ISO/TS 14048’s section “Inputs and outputs”

property flowProperties: FlowProperties#: List of flow properties (with all variable information linked to that respective flow).

property locations#: Contains reference to used location table for this dataset.

property modellingAndValidation: ModellingAndValidation#: Covers the five sub-sections 1) LCI method, 2) Data sources, treatment and representativeness (not used for flows), 3) Completeness (not used for flows), 4) Validation (not used for flows), and 5) Compliance.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.FlowPropertyDataSet#

Bases: ElementBase

Flow Property Dataset.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property flowPropertiesInformation: FlowPropertiesInformation#: Flow property information.

property modellingAndValidation: ModellingAndValidation#: Covers the five sub-sections 1) LCI method (not used), 2) Data sources, treatment and representativeness (only 3 fields), 3) Completeness (not used), 4) Validation, and 5) Compliance.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.ProcessDataSet#

Bases: ElementBase

Data set for unit processes, partly terminated systems, and LCI results. May contain LCIA results as well.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property exchanges: Exchanges#: Input/Output list of exchanges with the quantitative inventory data, as well as pre-calculated LCIA results.

property lciaResults: LCIAResults#: List with the pre-calculated LCIA results of the Input/Output list of this data set. May contain also inventory-type results such as primary energy consumption etc.

property locations#: Contains reference to used location table for this dataset.

property metaDataOnly#: Indicates whether this data set contains only meta data (no exchanges section).

property modellingAndValidation: ModellingAndValidation#: Covers the five sub-sections 1) LCI method and allocation, 2) Data sources, treatment and representativeness, 3) Completeness, 4) Validation, and 5) Compliance. (Section refers to LCI modelling and data treatment aspects etc., NOT the modeling of e.g. the input/output-relationships of a parameterised data set.)

property processInformation: ProcessInformation#: Corresponds to the ISO/TS 14048 section “Process description”. It comprises the following six sub-sections: 1) “Data set information” for data set identification and overarching information items, 2) “Quantitative reference”, 3) “Time”, 4) “Geography”, 5) “Technology” and 6) “Mathematical relations”.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.SourceDataSet#

Bases: ElementBase

Data set for bibliographical references to sources used, but also for reference to data set formats, databases, conformity systems etc.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property sourceInformation: SourceInformation#: Source information.

property version#: Indicates, which version of the ILCD format is used.

class pyilcd.UnitGroupDataSet#

Bases: ElementBase

Unit Group Dataset.

property administrativeInformation: AdministrativeInformation#: Information on data set management and administration.

property modellingAndValidation: ModellingAndValidation#: Sections used to a very limited degree; covers the five sub-sections 1) LCI method and allocation (not used for unit groups), 2) Data sources, treatment and representativeness (not used for unit groups), 3) Completeness (not used for unit groups), 4) Validation (not used for unit groups), and 5) Compliance.

property unitGroupInformation: UnitGroupInformation#: Unit group information.

property units: Units#: List of units that belong to this Unit group and are interconvertible among each other with a fixed factor, such as this can be done e.g. for kg, g, ounces, pounds etc. of the Unit group “Units of mass”.

property version#: Indicates, which version of the ILCD format is used.

pyilcd.parse_directory_contact_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ContactDataSet]]

pyilcd.parse_directory_flow_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowDataSet]]

pyilcd.parse_directory_flow_property_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowPropertyDataSet]]

pyilcd.parse_directory_process_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ProcessDataSet]]

pyilcd.parse_directory_source_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, SourceDataSet]]

pyilcd.parse_directory_unit_group_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, UnitGroupDataSet]]

pyilcd.parse_file_contact_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: ContactDataSet

pyilcd.parse_file_flow_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: FlowDataSet

pyilcd.parse_file_flow_property_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: FlowPropertyDataSet

pyilcd.parse_file_process_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: ProcessDataSet

pyilcd.parse_file_source_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: SourceDataSet

pyilcd.parse_file_unit_group_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: UnitGroupDataSet

pyilcd.parse_zip_file_contact_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ContactDataSet]]

pyilcd.parse_zip_file_flow_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowDataSet]]

pyilcd.parse_zip_file_flow_property_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, FlowPropertyDataSet]]

pyilcd.parse_zip_file_process_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, ProcessDataSet]]

pyilcd.parse_zip_file_source_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, SourceDataSet]]

pyilcd.parse_zip_file_unit_group_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, UnitGroupDataSet]]

pyilcd.save_ilcd_file(root, path, fill_defaults=False)#

Parameters:

root (ElementBase) –
path (str) –
fill_defaults (bool) –

Return type:

None

pyilcd.validate_directory_contact_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_directory_flow_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_directory_flow_property_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_directory_process_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_directory_source_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_directory_unit_group_dataset(dir_path, valid_suffixes=None)#

Parameters:

dir_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_file_contact_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.validate_file_flow_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.validate_file_flow_property_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.validate_file_process_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.validate_file_source_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.validate_file_unit_group_dataset(file)#

Parameters:: file (str | Path | StringIO) –
Return type:: None | List[str]

pyilcd.validate_zip_file_contact_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_zip_file_flow_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_zip_file_flow_property_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_zip_file_process_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_zip_file_source_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]

pyilcd.validate_zip_file_unit_group_dataset(file_path, valid_suffixes=None)#

Parameters:

file_path (str | Path) –
valid_suffixes (List[str] | None) –

Return type:

List[Tuple[Path, None | List[str]]]