Skip to content

[OutputManager] Removes use_name report filter option. #2876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ew3361zh merged 20 commits into from
Mar 25, 2026
Merged

[OutputManager] Removes use_name report filter option. #2876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
2d26c4d
switches diesel consumption to parse based on new output manager filt…
ew3361zh Mar 21, 2026
4490866
fixes broken unit tests
ew3361zh Mar 21, 2026
cef917a
Merge 4490866336d0e55ab8c927d6273f07d8829b5710 into 19a697be425755d8b…
ew3361zh Mar 21, 2026
4808e05
Apply Black Formatting
github-actions[bot] Mar 21, 2026
ed3a082
Update badges on README
ew3361zh Mar 21, 2026
b130af7
changelog
ew3361zh Mar 23, 2026
d62f4e6
fixes mypy errors
ew3361zh Mar 23, 2026
7ec264e
adds unit tests
ew3361zh Mar 23, 2026
96fa762
Merge 7ec264e47ff24f3addb99da9610800943d9b9357 into 19a697be425755d8b…
ew3361zh Mar 23, 2026
52a00d8
Apply Black Formatting
github-actions[bot] Mar 23, 2026
10d56a8
Update badges on README
ew3361zh Mar 23, 2026
2ca9394
addresses matthew's comments
ew3361zh Mar 25, 2026
e695261
Merge branch 'dev' into eval-use-name
ew3361zh Mar 25, 2026
eaf09e7
Merge e695261f48fbcb3e1d07c0dc26a78098a23cec04 into 4378126e6300c54f7…
ew3361zh Mar 25, 2026
78f25c9
Apply Black Formatting
github-actions[bot] Mar 25, 2026
13b1d77
Update badges on README
ew3361zh Mar 25, 2026
27618de
fixes mypy errors
ew3361zh Mar 25, 2026
fa7ed8d
Merge 27618de221ce6ce0797d70b28e6f0146ac8e7c70 into 4378126e6300c54f7…
ew3361zh Mar 25, 2026
fdb418d
Apply Black Formatting
github-actions[bot] Mar 25, 2026
0b29466
Update badges on README
ew3361zh Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Flake8](https://img.shields.io/badge/Flake8-passed-brightgreen)](https://github.com/RuminantFarmSystems/MASM/actions/workflows/combined_format_lint_test_mypy.yml)
[![Pytest](https://img.shields.io/badge/Pytest-passed-brightgreen)](https://github.com/RuminantFarmSystems/MASM/actions/workflows/combined_format_lint_test_mypy.yml)
[![Coverage](https://img.shields.io/badge/Coverage-99%25-brightgreen)](https://github.com/RuminantFarmSystems/MASM/actions/workflows/combined_format_lint_test_mypy.yml)
[![Mypy](https://img.shields.io/badge/Mypy-1215%20errors-red)](https://github.com/RuminantFarmSystems/MASM/actions/workflows/combined_format_lint_test_mypy.yml)
[![Mypy](https://img.shields.io/badge/Mypy-1212%20errors-red)](https://github.com/RuminantFarmSystems/MASM/actions/workflows/combined_format_lint_test_mypy.yml)


# RuFaS: Ruminant Farm Systems
Expand Down
308 changes: 169 additions & 139 deletions RUFAS/EEE/energy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,115 @@
from RUFAS.EEE.tractor import Tractor
from RUFAS.EEE.tractor_implement import TractorImplement

EEE_TO_OM_KEY_MAPPING = {
FieldOperationEvent.PLANTING: {
"crop_type": "crop",
"clay_percent": "average_clay_percent",
"field_production_size": "field_size",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
FieldOperationEvent.HARVEST: {
"crop_type": "crop",
"crop_yield": "dry_yield",
"field_production_size": "field_size",
"operation_year": "harvest_year",
"operation_day": "harvest_day",
"field_name": "field_name",
"harvest_type": "harvest_type",
},
FieldOperationEvent.MANURE_APPLICATION: {
"mass": "dry_matter_mass",
"dry_matter_fraction": "dry_matter_fraction",
"application_depth": "application_depth",
"field_production_size": "field_size",
"clay_percent": "average_clay_percent",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
FieldOperationEvent.TILLING: {
"application_depth": "tillage_depth",
"tillage_implement": "implement",
"field_production_size": "field_size",
"clay_percent": "average_clay_percent",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
FieldOperationEvent.FERTILIZER_APPLICATION: {
"mass": "mass",
"application_depth": "application_depth",
"field_production_size": "field_size",
"clay_percent": "average_clay_percent",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
}

CROP_AND_SOIL_FILTERS: list[dict[str, Any]] = [
{
"name": FieldOperationEvent.FERTILIZER_APPLICATION,
"filters": ["Field._record_fertilizer_application.fertilizer_application.field='.*'"],
"variables": [
"mass",
"application_depth",
"field_size",
"average_clay_percent",
"year",
"day",
"field_name",
],
},
{
"name": FieldOperationEvent.TILLING,
"filters": ["TillageApplication._record_tillage.tillage_record.field='.*'"],
"variables": [
"tillage_depth",
"implement",
"field_size",
"average_clay_percent",
"year",
"day",
"field_name",
],
},
{
"name": FieldOperationEvent.MANURE_APPLICATION,
"filters": ["Field._record_manure_application.manure_application.field='.*'"],
"variables": [
"dry_matter_mass",
"dry_matter_fraction",
"application_depth",
"field_size",
"average_clay_percent",
"year",
"day",
"field_name",
],
},
{
"name": FieldOperationEvent.HARVEST,
"filters": ["CropManagement._record_yield.harvest_yield.field='.*'"],
"variables": [
"dry_yield",
"crop",
"field_size",
"harvest_year",
"harvest_day",
"field_name",
"harvest_type",
],
},
{
"name": FieldOperationEvent.PLANTING,
"filters": ["Field._record_planting.crop_planting.field='.*'"],
"variables": ["crop", "field_size", "average_clay_percent", "year", "day", "field_name"],
},
]

im = InputManager()
om = OutputManager()

Expand All @@ -29,7 +138,7 @@ def estimate_all() -> None:
}
estimator = EnergyEstimator()
diesel_consumption_data_list = estimator.parse_inputs_for_diesel_consumption_calculation()
total_diesel_consumption_tractor_implement_liter_per_ha = 0
total_diesel_consumption_tractor_implement_liter_per_ha: float = 0.0
herd_size = im.get_data("animal.herd_information.herd_num")
for diesel_consumption_data_item in diesel_consumption_data_list:
harvest_type: HarvestOperation | None = None
Expand All @@ -41,7 +150,7 @@ def estimate_all() -> None:
herd_size=herd_size,
application_depth=diesel_consumption_data_item.get("application_depth"),
tillage_implement=diesel_consumption_data_item.get("tillage_implement"),
harvest_type=harvest_type
harvest_type=harvest_type,
)

diesel_consumption_tractor_implement_liter_per_ha = estimator.calculate_diesel_consumption(
Expand Down Expand Up @@ -88,7 +197,7 @@ def report_diesel_consumption(
"""
base_info_map = {
"class": EnergyEstimator.__name__,
"function": EnergyEstimator.estimate_all.__name__,
"function": EnergyEstimator.report_diesel_consumption.__name__,
Copy link
Collaborator Author

@ew3361zh ew3361zh Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was the incorrect function name previously and changing it will change existing filters using regex patterns with the old function name. I will update dev team channel once this PR is approved.

}
operation_event: FieldOperationEvent = diesel_consumption_data["operation_event"]
operation_event_str: str = (
Expand Down Expand Up @@ -133,23 +242,18 @@ def report_diesel_consumption(
diesel_consumption_data.get("application_depth"),
{**base_info_map, **{"units": MeasurementUnits.CENTIMETERS}},
)
if operation_event in [
FieldOperationEvent.MANURE_APPLICATION,
FieldOperationEvent.FERTILIZER_APPLICATION
]:
if operation_event in [FieldOperationEvent.MANURE_APPLICATION, FieldOperationEvent.FERTILIZER_APPLICATION]:
om.add_variable(
f"application_mass_{suffix}",
diesel_consumption_data.get("mass"),
{**base_info_map, **{"units": MeasurementUnits.KILOGRAMS_PER_HECTARE}},
)
if operation_event == FieldOperationEvent.TILLING:
tillage_implement_enum = diesel_consumption_data.get("tillage_implement")
tillage_implement = tillage_implement_enum.value if tillage_implement_enum is not None else None
om.add_variable(
f"tillage_implement_for_{suffix}",
(
diesel_consumption_data.get("tillage_implement").value
if diesel_consumption_data.get("tillage_implement")
else diesel_consumption_data.get("tillage_implement")
),
tillage_implement,
{**base_info_map, **{"units": MeasurementUnits.UNITLESS}},
)
om.add_variable(
Expand All @@ -162,132 +266,57 @@ def parse_inputs_for_diesel_consumption_calculation(self) -> list[dict[str, Any]
"""
Parses the OutputManager variables pool for diesel consumption calculation.
"""
crop_and_soil_filters = [
{
"name": FieldOperationEvent.FERTILIZER_APPLICATION,
"use_name": True,
"filters": ["Field._record_fertilizer_application.fertilizer_application.field='.*'"],
"variables": [
"mass",
"application_depth",
"field_size",
"average_clay_percent",
"year",
"day",
"field_name",
],
},
{
"name": FieldOperationEvent.TILLING,
"use_name": True,
"filters": ["TillageApplication._record_tillage.tillage_record.field='.*'"],
"variables": [
"tillage_depth",
"implement",
"field_size",
"average_clay_percent",
"year",
"day",
"field_name",
],
},
{
"name": FieldOperationEvent.MANURE_APPLICATION,
"use_name": True,
"filters": ["Field._record_manure_application.manure_application.field='.*'"],
"variables": [
"dry_matter_mass",
"dry_matter_fraction",
"application_depth",
"field_size",
"average_clay_percent",
"year",
"day",
"field_name",
],
},
{
"name": FieldOperationEvent.HARVEST,
"use_name": True,
"filters": ["CropManagement._record_yield.harvest_yield.field='.*'"],
"variables": [
"dry_yield", "crop", "field_size", "harvest_year", "harvest_day", "field_name", "harvest_type"
],
},
{
"name": FieldOperationEvent.PLANTING,
"use_name": True,
"filters": ["Field._record_planting.crop_planting.field='.*'"],
"variables": ["crop", "field_size", "average_clay_percent", "year", "day", "field_name"],
},
]
result: list[dict[str, Any]] = []
eee_to_om_key_mapping = {
FieldOperationEvent.PLANTING: {
"crop_type": "crop",
"clay_percent": "average_clay_percent",
"field_production_size": "field_size",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
FieldOperationEvent.HARVEST: {
"crop_type": "crop",
"crop_yield": "dry_yield",
"field_production_size": "field_size",
"operation_year": "harvest_year",
"operation_day": "harvest_day",
"field_name": "field_name",
"harvest_type": "harvest_type"
},
FieldOperationEvent.MANURE_APPLICATION: {
"mass": "dry_matter_mass",
"dry_matter_fraction": "dry_matter_fraction",
"application_depth": "application_depth",
"field_production_size": "field_size",
"clay_percent": "average_clay_percent",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
FieldOperationEvent.TILLING: {
"application_depth": "tillage_depth",
"tillage_implement": "implement",
"field_production_size": "field_size",
"clay_percent": "average_clay_percent",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
FieldOperationEvent.FERTILIZER_APPLICATION: {
"mass": "mass",
"application_depth": "application_depth",
"field_production_size": "field_size",
"clay_percent": "average_clay_percent",
"operation_year": "year",
"operation_day": "day",
"field_name": "field_name",
},
}
for filter in crop_and_soil_filters:
filtered_pool = om.filter_variables_pool(filter)
max_index = Utility.find_max_index_from_keys(filtered_pool)
if max_index is None or max_index < 0:

for filter_config in CROP_AND_SOIL_FILTERS:
filtered_pool = om.filter_variables_pool(filter_config)
if not filtered_pool:
continue
first_key_in_pool = next(iter(filtered_pool.keys()))
for event_type, key_mappings in eee_to_om_key_mapping.items():
if first_key_in_pool.startswith(event_type.value):
for index in range(max_index + 1):
key_prefix = f"{event_type}_{index}"
_, first_om_key_in_the_map = next(iter(key_mappings.items()))
length = len(filtered_pool[f"{key_prefix}.{first_om_key_in_the_map}"]["values"])
for i in range(length):
event_data = {
eee_key: filtered_pool[f"{key_prefix}.{om_key_suffix}"]["values"][i]
for eee_key, om_key_suffix in key_mappings.items()
}
event_data["operation_event"] = event_type
result.append(event_data)

event_type = filter_config["name"]
key_mappings = EEE_TO_OM_KEY_MAPPING[event_type]
required_suffixes = set(key_mappings.values())

group_prefixes = Utility.find_group_prefixes_from_keys(
data=filtered_pool,
required_suffixes=required_suffixes,
)
if not group_prefixes:
continue

first_required_suffix = next(iter(key_mappings.values()))

for key_prefix in group_prefixes:
first_key = f"{key_prefix}.{first_required_suffix}"
if first_key not in filtered_pool:
continue

values = filtered_pool[first_key].get("values", [])
length = len(values)

for i in range(length):
event_data: dict[str, Any] = {}

for eee_key, om_key_suffix in key_mappings.items():
full_key = f"{key_prefix}.{om_key_suffix}"
if full_key not in filtered_pool:
raise KeyError(
f"Expected key '{full_key}' not found in filtered pool for "
f"event type '{event_type.value}'."
)

field_values = filtered_pool[full_key].get("values", [])
if i >= len(field_values):
raise IndexError(
f"Index {i} out of range for key '{full_key}' while building "
f"diesel consumption event data."
)

event_data[eee_key] = field_values[i]

event_data["operation_event"] = event_type
result.append(event_data)

return result

def calculate_diesel_consumption(
Expand All @@ -297,7 +326,7 @@ def calculate_diesel_consumption(
tractor: Tractor,
clay_percent: float,
application_mass: float | None = None,
application_dm_content: float | None = None
application_dm_content: float | None = None,
) -> float:
"""
General estimate of diesel fuel consumption for a given attachment type and tractor size.
Expand Down Expand Up @@ -328,8 +357,9 @@ def calculate_diesel_consumption(
for implement in tractor.implements:
crop_yield_ton_ha = crop_yield * GeneralConstants.KILOGRAMS_TO_MEGAGRAMS
if application_mass and application_dm_content:
application_mass_per_ha = (application_mass * GeneralConstants.KILOGRAMS_TO_MEGAGRAMS
/ application_dm_content) / field_production_size
application_mass_per_ha = (
application_mass * GeneralConstants.KILOGRAMS_TO_MEGAGRAMS / application_dm_content
) / field_production_size
else:
application_mass_per_ha = None

Expand Down
Loading