EPPT-2585: Fire Severity Index: Add a DuffMoistureCode class to IMPROVER #2250

mo-philrelton · 2025-11-27T15:24:37Z

In order to calculate the daily Fire Severity Index, we require a Duff Moisture Code calculation. This class, and associated tests, partially reproduce the Canadian Forest Fire Weather Index from van Wagner and Pickett's 1985 FORTRAN implementation

Testing:

Ran tests and they passed OK
Added new tests for the new feature(s)

codecov · 2025-11-27T15:32:45Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (EPPT_2411_fire_severity_index_workflow_development@a2fcead). Learn more about missing BASE report.

Additional details and impacted files

@@                                  Coverage Diff                                  @@
##             EPPT_2411_fire_severity_index_workflow_development    #2250   +/-   ##
=====================================================================================
  Coverage                                                      ?   95.26%           
=====================================================================================
  Files                                                         ?      152           
  Lines                                                         ?    15391           
  Branches                                                      ?        0           
=====================================================================================
  Hits                                                          ?    14662           
  Misses                                                        ?      729           
  Partials                                                      ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ryan-cocking-mo

Tests all pass, code looks good, and equations match those in the literature. I have made some tiny suggestions around types in doc strings that I think makes them slightly neater (and works better when rendering the IMPROVER docs with Sphinx/Read the Docs).

ryan-cocking-mo · 2025-12-22T14:17:56Z

improver/fire_weather/duff_moisture_code.py

+        From Van Wagner and Pickett (1985), Page 6: Equation 16.
+
+        Args:
+            drying_rate (np.ndarray): The drying rate (RK).


Suggested change

drying_rate (np.ndarray): The drying rate (RK).

drying_rate: The drying rate, represented by 'K' in the original equations.

The symbol for drying rate is K in the equations, but having (K) in the docstring may be confused for units Kelvin.

ryan-cocking-mo · 2025-12-22T14:29:45Z

improver/fire_weather/duff_moisture_code.py

+        """Calculate the Duff Moisture Code (DMC).
+
+        Returns:
+            np.ndarray: The calculated DMC values for the current day.


Suggested change

np.ndarray: The calculated DMC values for the current day.

The calculated DMC values for the current day.

The IMPROVER setup for Sphinx/Read the Docs automatically infers the return type from the type hint. Removing it from the docstring will also add a hyperlink to the np.ndarray documentation.

I suspect we need to consider this comment on the other FireSeverity PRs if we want the docs to render correctly

ryan-cocking-mo · 2025-12-22T14:33:07Z

improver/fire_weather/duff_moisture_code.py

+        From Van Wagner and Pickett (1985), Page 6: Equation 16, Steps 3 & 4.
+
+        Returns:
+            np.ndarray: The drying rate (dimensionless). Shape matches input cube


Suggested change

np.ndarray: The drying rate (dimensionless). Shape matches input cube

The drying rate (dimensionless). Shape matches input cube

See previous comment on inferring return type from type hint.

ryan-cocking-mo · 2025-12-22T14:33:32Z

improver/fire_weather/duff_moisture_code.py

+            drying_rate (np.ndarray): The drying rate (RK).
+
+        Returns:
+            np.ndarray: The calculated DMC value.


Suggested change

np.ndarray: The calculated DMC value.

The calculated DMC value.

ryan-cocking-mo · 2025-12-22T14:38:43Z

improver_tests/fire_weather/test_duff_moisture_code.py

+    different previous DMC values.
+
+    Args:
+        precip_val (float): Precipitation value for all grid points.


Not a suggestion, just a comment: the types can be kept in brackets in test docstrings, because they are not processed by Sphinx/Read the Docs in the IMPROVER repository.

RDP-mo · 2025-12-23T14:54:53Z

improver/fire_weather/duff_moisture_code.py

+        """Calculate the Duff Moisture Code (DMC).
+
+        Returns:
+            np.ndarray: The calculated DMC values for the current day.


I suspect we need to consider this comment on the other FireSeverity PRs if we want the docs to render correctly

RDP-mo · 2025-12-23T15:12:32Z

improver_tests/fire_weather/test_duff_moisture_code.py

+    assert DuffMoistureCode.DMC_DAY_LENGTH_FACTORS == expected_factors
+
+
+@pytest.mark.parametrize(


This is quite tricky to read. 1 option would be

DMC_NEGATIVE = 20.0, 1.0, 50.0, -5.0 TEMPERATURE_TOO_HIGH =150.0, 1.0, 50.0, 6.0 TEMPERATURE_TOO_LOW = -150.0, 1.0, 50.0, 6.0 RELATIVE_HUMIDITY_TOO_HIGH = 20.0, 1.0, 150.0, 6.0 # Relative humidity above 100% NEGATIVE_RELATIVE_HUMIDITY = 20.0, 1.0, -10.0, 6.0 PRECIPITATION_NEGATIVE = 20.0, -5.0, 50.0, 6.0 @pytest.mark.parametrize( "temp_val, precip_val, rh_val, dmc_val, expected_error", [ (*TEMPERATURE_TOO_HIGH, "temperature contains values above valid maximum"), (*TEMPERATURE_TOO_LOW, "temperature contains values below valid minimum"), (*PRECIPITATION_NEGATIVE, "precipitation contains values below valid minimum"), (*RELATIVE_HUMIDITY_TOO_HIGH, "relative_humidity contains values above valid maximum"), (*NEGATIVE_RELATIVE_HUMIDITY, "relative_humidity contains values below valid minimum"), (*DMC_NEGATIVE, "input_dmc contains values below valid minimum"), ], ) def test_func

Note the * to expand the tuples as args

RDP-mo · 2025-12-23T15:13:43Z

improver_tests/fire_weather/test_duff_moisture_code.py

+    elif invalid_input_type == "input_dmc_nan":
+        dmc_val = np.nan
+    elif invalid_input_type == "input_dmc_inf":
+        dmc_val = np.inf


As covered in the other reviews these would be better as part of the parametrization of the test.

RDP-mo · 2025-12-23T15:14:01Z

improver_tests/fire_weather/test_duff_moisture_code.py

+    plugin = DuffMoistureCode()
+
+    # Process should complete without warnings since output stays in valid range
+    import warnings


Move import to top of file

mo-philrelton force-pushed the EPPT_2585_duffmoisturecode branch from b945990 to 553c6bd Compare December 16, 2025 16:11

mo-philrelton added 7 commits December 17, 2025 15:41

Adding working, documented implementation of the DuffMoistureCode class

b126dca

Adding initial versions of tests for DMC

e2862dd

Fixing warnings from log(0)s

d891272

Adding test for day length factors

b8690cf

Adding DMC to API

60299f6

Changes from ABC refactor

391ed19

Adding missing tests for valid inputs/outputs

0150a08

mo-philrelton force-pushed the EPPT_2585_duffmoisturecode branch from 553c6bd to 0150a08 Compare December 17, 2025 15:48

ryan-cocking-mo requested changes Dec 22, 2025

View reviewed changes

RDP-mo reviewed Dec 23, 2025

View reviewed changes

	drying_rate (np.ndarray): The drying rate (RK).
	drying_rate: The drying rate, represented by 'K' in the original equations.

	np.ndarray: The calculated DMC values for the current day.
	The calculated DMC values for the current day.

	np.ndarray: The drying rate (dimensionless). Shape matches input cube
	The drying rate (dimensionless). Shape matches input cube

	np.ndarray: The calculated DMC value.
	The calculated DMC value.

		assert DuffMoistureCode.DMC_DAY_LENGTH_FACTORS == expected_factors


		@pytest.mark.parametrize(

EPPT-2585: Fire Severity Index: Add a DuffMoistureCode class to IMPROVER #2250

Are you sure you want to change the base?

EPPT-2585: Fire Severity Index: Add a DuffMoistureCode class to IMPROVER #2250

Uh oh!

Conversation

mo-philrelton commented Nov 27, 2025

Uh oh!

codecov bot commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ryan-cocking-mo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Nov 27, 2025 •

edited

Loading