Document no effective cap for max royalty rate. Add unit test to assert that royalty rate is not supported for non-SAM-EM

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -992,15 +992,17 @@ def __init__(self, model: Model):
                         "increases a 4% rate (0.04) to 4.1% (0.041) in the next year."
         )
 
+        maximum_royalty_rate_default_val = 1.0
         self.maximum_royalty_rate = self.ParameterDict[self.maximum_royalty_rate.Name] = floatParameter(
             'Royalty Rate Maximum',
-            DefaultValue=1.0,  # Default to 100% (no effective cap)
+            DefaultValue=maximum_royalty_rate_default_val,
             Min=0.0,
             Max=1.0,
             UnitType=Units.PERCENT,
             PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH,
-            ToolTipText="The maximum royalty rate after escalation, expressed as a fraction (e.g., 0.06 for a 6% cap)."
+            ToolTipText=f"The maximum royalty rate after escalation, expressed as a fraction (e.g., 0.06 for a 6% cap)."
+                        f"{' Defaults to 100% (no effective cap).' if maximum_royalty_rate_default_val == 1.0 else ''}"
         )
 
         # TODO support custom royalty rate schedule as a list parameter

src/geophires_x_schema_generator/geophires-request.json

@@ -1657,7 +1657,7 @@
       "maximum": 1.0
     },
     "Royalty Rate Maximum": {
-      "description": "The maximum royalty rate after escalation, expressed as a fraction (e.g., 0.06 for a 6% cap).",
+      "description": "The maximum royalty rate after escalation, expressed as a fraction (e.g., 0.06 for a 6% cap). Defaults to 100% (no effective cap).",
       "type": "number",
       "units": "",
       "category": "Economics",

tests/test_geophires_x.py

@@ -1457,3 +1457,16 @@ def test_royalty_rate_with_addon(self):
         addon_cash_flow = _cash_flow_profile_row(result.result['SAM CASH FLOW PROFILE'], 'Capacity payment revenue ($)')
         self.assertEqual(0, addon_cash_flow[0])
         self.assertTrue(all(it == addon_profit_MUSD * 1e6 for it in addon_cash_flow[1:]))
+
+    def test_royalty_rate_not_supported_for_non_sam_economic_models(self):
+        with self.assertRaises(RuntimeError) as re:
+            GeophiresXClient().get_geophires_result(
+                ImmutableGeophiresInputParameters(
+                    from_file_path=self._get_test_file_path('examples/Fervo_Project_Cape-3.txt'),
+                    params={
+                        'Royalty Rate': 0.1,
+                    },
+                )
+            )
+
+        self.assertIn('Royalties are only supported for SAM Economic Models', str(re.exception))