Skip to content

meca: inaccurate and confusing parameter names for "PRINCIPAL_AXIS" convention #1612

@seisman

Description

@seisman

Description of the problem

The "PRICIPAL_AXIS" convention has 10 parameters: the value (in 10*exponent dynes-cm), azimuth, and plunge of N, T, and P axis, and also the exponent of the values. See https://docs.generic-mapping-tools.org/latest/supplements/seis/meca.html#s for the official documentation. Currently, the meca function defines the following parameters:

pygmt/pygmt/src/meca.py

Lines 255 to 266 in 4b80f3c

"PRINCIPAL_AXIS": [
"t_exponent",
"t_azimuth",
"t_plunge",
"n_exponent",
"n_azimuth",
"n_plunge",
"p_exponent",
"p_azimuth",
"p_plunge",
"exponent",
],

The parameter name t_exponent, n_exponent, and p_exponent is inaccurate and confusing, and should be renamed to t_value, n_value, and p_value.

I think we should make the change in a backward-compatible way and it should go through the deprecation cycle.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions