bw_interface_schemas.lci
========================

.. py:module:: bw_interface_schemas.lci


Attributes
----------

.. autoapisummary::

   bw_interface_schemas.lci.hiss


Classes
-------

.. autoapisummary::

   bw_interface_schemas.lci.DataSource
   bw_interface_schemas.lci.Edge
   bw_interface_schemas.lci.ElementaryFlow
   bw_interface_schemas.lci.Node
   bw_interface_schemas.lci.Parsimonius
   bw_interface_schemas.lci.Process
   bw_interface_schemas.lci.ProcessWithReferenceProduct
   bw_interface_schemas.lci.Product
   bw_interface_schemas.lci.UncertaintyDistribution


Module Contents
---------------

.. py:class:: DataSource

   Bases: :py:obj:`Parsimonius`


   A data source, such as a publication or field measurement.

   Very preliminary.


   .. py:attribute:: authors
      :type:  list[str]


   .. py:attribute:: doi
      :type:  Optional[str]
      :value: None



   .. py:attribute:: title
      :type:  str


   .. py:attribute:: year
      :type:  int


.. py:class:: Edge

   Bases: :py:obj:`UncertaintyDistribution`


   An quantitative edge linking two nodes in the graph.


   .. py:attribute:: edge_type
      :type:  str


   .. py:attribute:: properties
      :type:  dict[str, Union[float, int]]


   .. py:attribute:: source
      :type:  Node


   .. py:attribute:: tags
      :type:  Optional[dict[str, pydantic.JsonValue]]
      :value: None



   .. py:attribute:: target
      :type:  Node


.. py:class:: ElementaryFlow

   Bases: :py:obj:`Node`


   Change defaule `model_dump` behaviour to not export unset values by default


   .. py:attribute:: context
      :type:  list[str]


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: unit
      :type:  str


.. py:class:: Node

   Bases: :py:obj:`Parsimonius`


   Change defaule `model_dump` behaviour to not export unset values by default


   .. py:attribute:: code
      :type:  str


   .. py:attribute:: comment
      :type:  Union[str, dict[str, str], None]
      :value: None



   .. py:attribute:: created
      :type:  Optional[datetime.datetime]
      :value: None



   .. py:attribute:: database
      :type:  str


   .. py:attribute:: exchanges
      :type:  list[Edge]
      :value: []



   .. py:attribute:: filename
      :type:  Optional[str]
      :value: None



   .. py:attribute:: location
      :type:  Optional[str]
      :value: None



   .. py:attribute:: modified
      :type:  Optional[datetime.datetime]
      :value: None



   .. py:attribute:: name
      :type:  Optional[str]
      :value: None



   .. py:attribute:: node_type
      :type:  Optional[str]


   .. py:attribute:: references
      :type:  Optional[list[DataSource]]
      :value: None



   .. py:attribute:: tags
      :type:  Optional[dict[str, pydantic.JsonValue]]
      :value: None



   .. py:attribute:: unit
      :type:  Optional[str]
      :value: None



.. py:class:: Parsimonius

   Bases: :py:obj:`pydantic.BaseModel`


   Change defaule `model_dump` behaviour to not export unset values by default


   .. py:method:: model_dump(exclude_unset=True, *args, **kwargs)


   .. py:attribute:: model_config


.. py:class:: Process

   Bases: :py:obj:`Node`


   A generic process, possibly multi-functional. Does not have a reference product.

   Only difference from `Node` is that some more fields are required.


   .. py:attribute:: location
      :type:  str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: unit
      :type:  str


.. py:class:: ProcessWithReferenceProduct

   Bases: :py:obj:`Process`


   Chimaera which serves as both a product and a process in the graph.


   .. py:attribute:: model_config


   .. py:attribute:: production_amount
      :type:  Optional[float]
      :value: None



   .. py:attribute:: properties
      :type:  Optional[dict[str, Union[float, int]]]
      :value: None



   .. py:attribute:: reference_product
      :type:  str


.. py:class:: Product

   Bases: :py:obj:`Node`


   Change defaule `model_dump` behaviour to not export unset values by default


   .. py:attribute:: location
      :type:  Optional[str]
      :value: None



   .. py:attribute:: name
      :type:  str


   .. py:attribute:: properties
      :type:  dict[str, Union[float, int]]


   .. py:attribute:: unit
      :type:  str


.. py:class:: UncertaintyDistribution

   Bases: :py:obj:`Parsimonius`


   Separate out the fields used in uncertainty distributions


   .. py:attribute:: amount
      :type:  float


   .. py:attribute:: loc
      :type:  Optional[float]
      :value: None



   .. py:attribute:: maximum
      :type:  Optional[float]
      :value: None



   .. py:attribute:: minimum
      :type:  Optional[float]
      :value: None



   .. py:attribute:: negative
      :type:  Optional[bool]
      :value: None



   .. py:attribute:: scale
      :type:  Optional[float]
      :value: None



   .. py:attribute:: shape
      :type:  Optional[float]
      :value: None



   .. py:attribute:: uncertainty_type
      :type:  Optional[int]
      :value: None



.. py:data:: hiss