Update base schemas

bw_interface_schemas/__init__.py

@@ -2,7 +2,22 @@
 
 __all__ = (
     "__version__",
-    # Add functions and variables you want exposed in `bw_interface_schemas.` namespace here
+    "CombinedProcessWithReferenceProduct",
+    "ElementaryFlow",
+    "Node",
+    "Process",
+    "Product",
+    "Source",
 )
 
 __version__ = "0.0.1"
+
+
+from .lci import (
+    CombinedProcessWithReferenceProduct,
+    ElementaryFlow,
+    Node,
+    Process,
+    Product,
+    Source,
+)

bw_interface_schemas/lci.py

@@ -0,0 +1,82 @@
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, JsonValue
+from datetime import datetime
+
+
+class Source(BaseModel):
+    """A data source, such as a publication or field measurement.
+
+    Very preliminary."""
+
+    authors: list[str]
+    year: int
+    title: str
+    doi: Optional[str] = None
+
+    def model_dump(self, exclude_unset=True, *args, **kwargs):
+        """Make `exclude_unset` True by default."""
+        return super().model_dump(*args, exclude_unset=exclude_unset, **kwargs)
+
+
+class Node(BaseModel):
+    # Combination of database and code uniquely identifies a node
+    code: str
+    database: str
+    # Recommended labels for these attributes
+    created: Optional[datetime] = None
+    modified: Optional[datetime] = None
+    name: Optional[str] = None
+    unit: Optional[str] = None
+    location: Optional[str] = None
+    type: Optional[str] = None
+    comment: Optional[str | dict[str, str]] = None
+    filename: Optional[str] = None
+    references: Optional[list[Source]] = None
+    # Was previously classifications - we want a more generic categorical set
+    tags: Optional[dict[str, JsonValue]] = None
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+
+    def model_dump(self, exclude_unset=True, *args, **kwargs):
+        """Make `exclude_unset` True by default."""
+        return super().model_dump(*args, exclude_unset=exclude_unset, **kwargs)
+
+
+class Process(Node):
+    """A generic process, possibly multi-functional. Does not have a reference product.
+
+    Only difference from `Node` is that some more fields are required."""
+
+    name: str
+    unit: str
+    location: str
+    # TBD: Time range?
+
+
+class CombinedProcessWithReferenceProduct(Process):
+    """Chimaera which serves as both a product and a process in the graph."""
+
+    # Was previously "reference product", need the underscore here
+    reference_product: str
+    # Optional name for the amount of reference product produced.
+    # Duplicates information in the exchanges.
+    # Should be net amount.
+    production_amount: Optional[float] = None
+
+
+class Product(Node):
+    name: str
+    unit: str
+    # Some products are the same globally, other have specific local properties
+    location: Optional[str] = None
+    properties: list  # TBD
+
+
+class ElementaryFlow(Node):
+    # Should be context, this is for backwards compatibility
+    categories: list[str]
+    name: str
+    unit: str