pygmt.exceptions.GMTParameterError

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

Raised when parameters are missing or invalid.

Parameters:

  • required (str | Iterable[str] | None, default: None) – Name or a collection of names of required parameters.

  • at_least_one (Iterable[str] | None, default: None) – A collection of parameter names, of which at least one must be specified.

  • at_most_one (Iterable[str] | None, default: None) – A collection of mutually exclusive parameter names, of which at most one can be specified.

  • conflicts_with (tuple[str, Iterable[str]] | None, default: None) – A tuple with the parameter name and a collection of conflicting parameter names, indicating which parameters cannot be used together.

  • reason (str | None, default: None) – Detailed reason why the parameters are invalid.