Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extra_coords option to coordinate generators #145

Merged
merged 1 commit into from
Oct 11, 2018
Merged

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Oct 11, 2018

The grid_coordinates, scatter_points, and profile_coordinates all
accept a new a extra_coords argument with the constant value to be
used as an extra coordinate. If given, then the output will have an
extra coordinate array of the same shape as the rest and with that
single value. If a list is given, multiple extra coordinate arrays will
be returned.

This can be used to specify constant coordinates to a grid generator,
like height or time, to generate a 2D grid/scatter/profile from data
that requires 3+ coordinates.

A step towards #138

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.

The `grid_coordinates`, `scatter_points`, and `profile_coordinates` all
accept a new a `extra_coords` argument with the constant value to be
used as an extra coordinate. If given, then the output will have an
extra coordinate array of the same shape as the rest and with that
single value. If a list is given, multiple extra coordinate arrays will
be returned.

This can be used to specify constant coordinates to a grid generator,
like height or time, to generate a 2D grid/scatter/profile from data
that requires 3+ coordinates.

A step towards #138
@leouieda leouieda merged commit 5a31c55 into master Oct 11, 2018
@leouieda leouieda deleted the extra-coords branch October 11, 2018 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant