Skip to content

Conversation

@seisman
Copy link
Member

@seisman seisman commented Nov 20, 2025

Just regular migration. No other changes.

@seisman seisman added this to the 0.18.0 milestone Nov 20, 2025
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Nov 20, 2025
Comment on lines 57 to 59
Azimuthal direction for a directional derivative; *azim* is the
angle in the x,y plane measured in degrees positive clockwise from
north (the positive y-direction) toward east (the positive x-direction). The
Copy link
Member

@yvonnefroehlich yvonnefroehlich Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we change "azim" to "azimuth" we need to update the following docstrings.

Suggested change
Azimuthal direction for a directional derivative; *azim* is the
angle in the x,y plane measured in degrees positive clockwise from
north (the positive y-direction) toward east (the positive x-direction). The
Azimuthal direction for a directional derivative; *azimuth* is the
angle in the x,y plane measured in degrees positive clockwise from
north (the positive y-direction) toward east (the positive x-direction). The

Unfortuantely I can only suggest changes for the first few lines.

        negative of the directional derivative,
        :math:`-(\frac{{dz}}{{dx}}\sin(\mbox{{azimuth}}) + \
        \frac{{dz}}{{dy}}\cos(\mbox{{azimuth}}))`, is found; negation yields
        positive values when the slope of :math:`z(x,y)` is downhill in the
        *azimuth* direction, the correct sense for shading the illumination of an
        image by a light source above the x,y plane shining from the *azimuth*
        direction. Optionally, supply two azimuths, *azimuth*/*azimuth2*, in which
        case the gradients in each of these directions are calculated and the
        one larger in magnitude is retained; this is useful for illuminating
        data with two directions of lineated structures, e.g., *0*/*270*
        illuminates from the north (top) and west (left).  Finally, if *azimuth*
        is a file it must be a grid of the same domain, spacing and
        registration as *grid* that will update the azimuth at each output
        node when computing the directional derivatives.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to azim. Will work on the docstrings in future PRs instead.

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Nov 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

final review call This PR requires final review and approval from a second reviewer maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants