def test_simple_cross_year_component(self):
bb = benefit.BenefitBox(low_flow=200,
high_flow=400,
start_day_of_water_year=200,
end_day_of_water_year=50,
component_name="test crossyear component")
# bb.plot_annual_benefit() - was just for visualizing the box we set up for testing
# at flows of 180 and 420, these will always have 0 benefit
for day in range(0, 366):
self.assertEqual(bb.single_flow_benefit(420, day_of_year=day), 0)
self.assertEqual(bb.single_flow_benefit(180, day_of_year=day), 0)
# on these days, any flow should be 0 benefit
for flow in range(0, 450):
self.assertEqual(bb.single_flow_benefit(flow, day_of_year=70), 0)
self.assertEqual(bb.single_flow_benefit(flow, day_of_year=180), 0)
self.assertEqual(bb.single_flow_benefit(300, day_of_year=25),
1) # a random set of values within the bulk of
self.assertEqual(bb.single_flow_benefit(350, day_of_year=250),
1) # the area of full benefit
self.assertEqual(bb.single_flow_benefit(375, day_of_year=300), 1)
self.assertEqual(bb.single_flow_benefit(250, day_of_year=365), 1)
edge_value = bb.single_flow_benefit(
250, day_of_year=200) # get test values in the fuzzy margins
edge_value2 = bb.single_flow_benefit(200, day_of_year=200)
edge_value3 = bb.single_flow_benefit(200, day_of_year=300)
self.assertLess(edge_value, 1) # fuzzy left edge
self.assertLess(edge_value2, 1) # fuzzy corner
self.assertLess(edge_value3, 1) # fuzzy bottom edge
self.assertGreater(edge_value, 0)
self.assertGreater(edge_value2, 0)
self.assertGreater(edge_value3, 0)
def test_cross_year_component_defined_with_data(self):
"""
The pathways we use when we define all the q values are a little different than
what happens when we define the hard boundaries and have it compute everything.
This test makes sure that if we go the route of providing the q values, we
get the right results too. Part of the difference is that in one case we explicitly
set values that are beyond the end of the year, and in the other case it has to compute
the values that cross the water year boundary. Getting it right in the case of setting
the values explicitly is important because that's the most likely scenario.
:return:
"""
bb = benefit.BenefitBox(component_name="Dry-season base flow",
segment_id="14992951")
bb.flow_item.set_values(decimal.Decimal('48.41'),
decimal.Decimal('67.27'),
decimal.Decimal('137.94'),
decimal.Decimal('177.50'))
bb.date_item.set_values(273, 282, 457, 477)
# bb.plot_annual_benefit() - was just for visualizing the box we set up for testing
# at flows of 180 and 420, these will always have 0 benefit
for day in range(0, 366):
self.assertEqual(bb.single_flow_benefit(178, day_of_year=day), 0)
self.assertEqual(bb.single_flow_benefit(47, day_of_year=day), 0)
# on these days, any flow should be 0 benefit
for flow in range(0, 200):
self.assertEqual(bb.single_flow_benefit(flow, day_of_year=125), 0)
self.assertEqual(bb.single_flow_benefit(flow, day_of_year=272), 0)
self.assertEqual(bb.single_flow_benefit(125, day_of_year=25),
1) # a random set of values within the bulk of
self.assertEqual(bb.single_flow_benefit(75, day_of_year=80),
1) # the area of full benefit
self.assertEqual(bb.single_flow_benefit(130, day_of_year=300), 1)
self.assertEqual(bb.single_flow_benefit(100, day_of_year=365), 1)
edge_value = bb.single_flow_benefit(
150, day_of_year=50) # get test values in the fuzzy margins
edge_value2 = bb.single_flow_benefit(150, day_of_year=100)
edge_value3 = bb.single_flow_benefit(100, day_of_year=100)
self.assertLess(edge_value, 1) # fuzzy top edge
self.assertLess(edge_value2, 1) # fuzzy corner
self.assertLess(edge_value3, 1) # fuzzy right edge
self.assertGreater(edge_value, 0)
self.assertGreater(edge_value2, 0)
self.assertGreater(edge_value3, 0)
def test_q_calculation_with_margin(self):
"""
Tests that the q values get put in the correct place with a standard margin of 0.1
:return:
"""
bb = benefit.BenefitBox(low_flow=200,
high_flow=400,
start_day_of_water_year=0,
end_day_of_water_year=365,
flow_margin=0.1)
self.assertAlmostEqual(bb.flow_item._q1, 180)
self.assertAlmostEqual(bb.flow_item._q2, 220)
self.assertAlmostEqual(bb.flow_item._q3, 380)
self.assertAlmostEqual(bb.flow_item._q4, 420)
def test_date_q_values_at_boundaries(self):
"""
This test makes sure that when we have date values at the boundaries of water years, we don't slope the
benefit function
:return:
"""
bb = benefit.BenefitBox(low_flow=200,
high_flow=400,
start_day_of_water_year=0,
end_day_of_water_year=365,
flow_margin=0.1)
self.assertEqual(bb.date_item._q1, bb.date_item._q2)
self.assertEqual(bb.date_item._q1, 0)
self.assertEqual(bb.date_item._q3, bb.date_item._q4)
self.assertEqual(bb.date_item._q3, 365)
def setUp(self):
self.bb = benefit.BenefitBox(low_flow=200,
high_flow=400,
start_day_of_water_year=0,
end_day_of_water_year=365)