pygmt.exceptions.GMTParameterError

exception pygmt.exceptions.GMTParameterError(*, required=None, at_least_one=None, at_most_one=None, reason=None)[source]

Raised when parameters are missing or invalid.

Parameters:

required (str | set[str] | None, default: None) – Name or a set of names of required parameters.
at_least_one (set[str] | None, default: None) – A set of parameter names, of which at least one must be specified.
at_most_one (set[str] | None, default: None) – A set of mutually exclusive parameter names, of which at most one can be specified.
reason (str | None, default: None) – Detailed reason why the parameters are invalid.