feat: Add tree type to meta data

The tree type can either be `coniferous` or `deciduous`.

Author: rschiffer

api/templates/yield-table-meta.html

@@ -34,6 +34,7 @@ <h2 class="mb-2 mt-10 text-xl font-semibold text-gray-900">
                   yield_class_step
                 </th>
                 <th scope="col" class="px-6 py-3 font-mono">age_step</th>
+                <th scope="col" class="px-6 py-3 font-mono">treey_type</th>
                 <th scope="col" class="px-6 py-3 font-mono">
                   available_columns
                 </th>
@@ -77,6 +78,9 @@ <h2 class="mb-2 mt-10 text-xl font-semibold text-gray-900">
                 <td class="px-6 py-4 font-mono text-right">
                   {{data.age_step}}
                 </td>
+                <td class="px-6 py-4 font-mono text-right">
+                  {{data.tree_type.value}}
+                </td>
                 <td class="px-6 py-4 font-mono">
                   <ul class="list-disc list-inside">
                     {% for available_column in data.available_columns %}

api/templates/yield-tables-meta.html

@@ -34,6 +34,7 @@ <h2 class="mb-2 mt-10 text-xl font-semibold text-gray-900">
                   yield_class_step
                 </th>
                 <th scope="col" class="px-6 py-3 font-mono">age_step</th>
+                <th scope="col" class="px-6 py-3 font-mono">tree_type</th>
               </tr>
             </thead>
             <tbody>
@@ -86,6 +87,9 @@ <h2 class="mb-2 mt-10 text-xl font-semibold text-gray-900">
                 <td class="px-6 py-4 font-mono text-right">
                   {{yield_table_meta.age_step}}
                 </td>
+                <td class="px-6 py-4 font-mono text-right">
+                  {{yield_table_meta.tree_type.value}}
+                </td>
               </tr>
               {% endfor %}
             </tbody>

docs/data_model.md

@@ -17,6 +17,7 @@ The CSV files are structured as follows:
     - `link`: A link to the source of the yield table or the yield table itself.
     - `yield_class_step`: The step between the yield classes.
     - `age_step`: The step between the ages.
+    - `tree_type`: The tree type: `coniferous` or `deciduous`.
 
 * `yield_tables.csv`: Contains the yield tables.
     - `id`: The unique identifier of the yield table.

src/openyieldtables/data/yield_tables_meta.csv

@@ -1,8 +1,14 @@
+from enum import Enum
 from typing import List, Optional, Union
 
 from pydantic import BaseModel
 
 
+class TreeType(str, Enum):
+    coniferous = "coniferous"
+    deciduous = "deciduous"
+
+
 class YieldTableMeta(BaseModel):
     id: int
     title: str
@@ -13,6 +19,7 @@ class YieldTableMeta(BaseModel):
     yield_class_step: Optional[float] = None
     age_step: Optional[int] = None
     available_columns: List[str]
+    tree_type: TreeType
 
 
 class YieldClassRow(BaseModel):

src/openyieldtables/models/yieldtable.py

@@ -2,6 +2,8 @@
 from pathlib import Path
 from typing import Dict, List, Optional, TypedDict, Union, cast
 
+from openyieldtables.models.yieldtable import TreeType
+
 from .models import (
     YieldClass,
     YieldClassRow,
@@ -27,6 +29,7 @@ class YieldTableMetaCSVRow(TypedDict, total=False):
     yield_class_step: Optional[float]
     age_step: Optional[int]
     available_columns: List[str]
+    tree_type: TreeType
 
 
 def get_yield_tables_meta() -> List[YieldTableMeta]:
@@ -73,6 +76,7 @@ def get_yield_tables_meta() -> List[YieldTableMeta]:
                     "age_step": (
                         int(row["age_step"]) if row.get("age_step") else None
                     ),
+                    "tree_type": row.get("tree_type"),
                     "available_columns": find_available_columns(
                         csv_path_yield_tables,
                         "id",

src/openyieldtables/yieldtables.py

@@ -1,6 +1,7 @@
 from fastapi.testclient import TestClient
 
 from api.main import app
+from openyieldtables.models.yieldtable import TreeType
 
 client = TestClient(app, headers={"accept": "application/json"})
 
@@ -18,6 +19,7 @@ def test_read_yield_tables_meta():
         "link": "https://www.avbuch-shop.at/landwirtschaft/lehrbuecher/1347/hilfstafeln-fuer-die-forsteinrichtung",  # noqa E501
         "yield_class_step": 1.0,
         "age_step": 10,
+        "tree_type": TreeType.coniferous,
         "available_columns": [
             "id",
             "yield_class",
@@ -44,6 +46,7 @@ def test_read_yield_tables_meta():
         "link": "https://www.tirol.gv.at/umwelt/wald/waldwirtschaft/ertragstafeln-in-tirol/",  # noqa E501
         "yield_class_step": 1.0,
         "age_step": 10,
+        "tree_type": TreeType.coniferous,
         "available_columns": [
             "id",
             "yield_class",
@@ -75,6 +78,7 @@ def test_read_yield_table_meta():
         "link": "https://www.avbuch-shop.at/landwirtschaft/lehrbuecher/1347/hilfstafeln-fuer-die-forsteinrichtung",  # noqa E501
         "yield_class_step": 1.0,
         "age_step": 10,
+        "tree_type": TreeType.coniferous,
         "available_columns": [
             "id",
             "yield_class",

tests/test_api_yieldtablesmeta.py

@@ -8,6 +8,7 @@
     YieldTableData,
     YieldTableMeta,
 )
+from openyieldtables.models.yieldtable import TreeType
 
 
 def test_yield_table_meta_valid():
@@ -21,6 +22,7 @@ def test_yield_table_meta_valid():
         "link": "https://example.com",
         "yield_class_step": 1,
         "age_step": 10,
+        "tree_type": TreeType.coniferous,
         "available_columns": [
             "id",
             "name",
@@ -46,6 +48,22 @@ def test_yield_table_meta_invalid():
         "link": "https://example.com",
         "yield_class_step": 1,
         "age_step": 10,
+        "tree_type": TreeType.coniferous,
+        "available_columns": [],
+    }
+    with pytest.raises(ValidationError):
+        YieldTableMeta(**invalid_data)
+
+    invalid_data = {
+        "id": 1,
+        "title": "yield_table_name",
+        "country_codes": ["AT"],
+        "type": "dgz_100",
+        "source": "source",
+        "link": "https://example.com",
+        "yield_class_step": 1,
+        "age_step": 10,
+        "tree_type": "invalid_tree_type",  # Invalid value for 'tree_type
         "available_columns": [],
     }
     with pytest.raises(ValidationError):
@@ -59,6 +77,7 @@ def test_yield_table_meta_defaults():
         "title": "yield_table_name",
         "country_codes": ["AT"],
         "source": "source",
+        "tree_type": TreeType.coniferous,
         "available_columns": [
             "id",
             "name",
@@ -94,6 +113,7 @@ def test_yield_table_valid_data():
         title="yield_table_name",
         country_codes=["AT", "DE"],
         source="source",
+        tree_type=TreeType.coniferous,
         available_columns=[
             "id",
             "name",

tests/test_models.py

@@ -1,5 +1,6 @@
 import pytest
 
+from openyieldtables.models.yieldtable import TreeType
 from openyieldtables.yieldtables import get_yield_table, get_yield_tables_meta
 
 
@@ -16,6 +17,7 @@ def test_get_yield_tables_meta():
         "link": "https://www.avbuch-shop.at/landwirtschaft/lehrbuecher/1347/hilfstafeln-fuer-die-forsteinrichtung",  # noqa E501
         "yield_class_step": 1.0,
         "age_step": 10,
+        "tree_type": TreeType.coniferous,
         "available_columns": [
             "id",
             "yield_class",
@@ -42,6 +44,7 @@ def test_get_yield_tables_meta():
         "link": "https://www.tirol.gv.at/umwelt/wald/waldwirtschaft/ertragstafeln-in-tirol/",  # noqa E501
         "yield_class_step": 1.0,
         "age_step": 10,
+        "tree_type": TreeType.coniferous,
         "available_columns": [
             "id",
             "yield_class",