InterpolatedVolumeParameter documentation is confusing

[Batch21]

The API documentation shows this:

Generic interpolation parameter calculated from current volume

init(self, model, node, x, y, interp_kwargs=None, **kwargs)
Initialize self. See help(type(self)) for accurate signature.

However if you defined the parameter in json you have to use volumes and values instead of x and y as the argument keys.

InterpolatedFlowParameter has the same issue

Easiest solution would be to add an __init__ function with correct arg names that just supers the parent class

[jetuk]

pywr/pywr/parameters/parameters.py

Line 118 in e7b4e35

def __init__(self, model, node, x, y, interp_kwargs=None, **kwargs):

Just rename x and y to volumes and values respectively?

Same issue here:

pywr/pywr/parameters/parameters.py

Line 140 in e7b4e35

def __init__(self, model, node, x, y, interp_kwargs=None, **kwargs):

[Batch21]

Not sure what I was looking at when I thought the classes didn't have init funcs. I've update the arg names and docstrings in #890

It looks like neither parameter is tested directly though they are used in other tests?

Also it is not possible to set any of the interp_kwargs in the json other than the kind. Maybe the loads function should assume that anything left in data should be added to that input arg?

[jetuk]

Also it is not possible to set any of the interp_kwargs in the json other than the kind. Maybe the loads function should assume that anything left in data should be added to that input arg?

I think it would be better to have interp_kwargs as a key with a sub-dictionary in the JSON. Let the __init__ method handle default arguments. This is how the schema branch does the pandas kwargs and it means top level of the JSON does not have open ended keywords.

[Batch21]

That is a better way of doing it. Might have to account for the kind arg not being in the interp_kwargs sub-dictionary for backwards compatibility.

[jetuk]

#890 solved the main issue here. Shall we keep this open for the interp_kwargs issue as well?