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

Create different number of mesh nodes in x- and y-direction #21

Merged
merged 5 commits into from
Sep 18, 2024

Conversation

joeloskarsson
Copy link
Contributor

@joeloskarsson joeloskarsson commented Sep 10, 2024

Describe your changes

Currently the 2d multirange graphs created for multiscale and hierarchical graphs are restricted to laying out mesh nodes in an $n \times n$ grid. This is suitable for forecasting areas that are roughly square, but a poor choice for rectangular areas with a large difference between it's height and width.

This PR updates the way multiscale and hierarchical graphs are created to compute the refinement (or equivalently the number of mesh nodes at each level) separately in the x- and y-directions. The result of this is probably best understood by an example:

Here a mesh graph is created for an area with $10 \times 30$ grid nodes. We are making a hierarchical graph, plotting only nodes. Grid nodes have level -1. Before this change the graph would look like this:

hi_old

Note that for level 0 there are 8 mesh nodes created in each direction, although this is way too many for the y-direction. This results in very short distances within the mesh in the y-direction compared to the x-direction. The higher levels share the same problem.

After this change the same graph looks like this:

hi_new

Now the distance between mesh nodes is roughly the same in the x- and y-direction. Note that with this change we can no longer fit 3 mesh levels. This is actually desirable behavior, as the height of this area is actually too small to properly fit 3 levels.

This change builds upon #19 , and should be merged after that.

Issue Link

This provides some potential answers to #2. If those outstanding questions do not require further discussion I think this can close #2.

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the documentation to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging)

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

@joeloskarsson joeloskarsson added the enhancement New feature or request label Sep 10, 2024
@joeloskarsson joeloskarsson self-assigned this Sep 10, 2024
@joeloskarsson
Copy link
Contributor Author

Note that as this builds upon #21 the diff includes also those changes at the moment, and is not very useful. Once #21 is merged it will be more useful. Meanwhile a diff for only this PR can be found at: joeloskarsson/weather-model-graphs@archetype_changes...joeloskarsson:weather-model-graphs:coord_wise_refinement

@leifdenby
Copy link
Member

Now the distance between mesh nodes is roughly the same in the x- and y-direction. Note that with this change we can no longer fit 3 mesh levels. This is actually desirable behavior, as the height of this area is actually too small to properly fit 3 levels.

This makes a lot of sense, and thank you for adding the example image too. It makes it really clear what the improvement is here. I will give this a proper review once #21 is in so that it easier to understand the changes that this PR uniquely introduces

@joeloskarsson
Copy link
Contributor Author

@leifdenby Now #19 is merged, so the diff for this PR is readable 😄

@joeloskarsson joeloskarsson mentioned this pull request Sep 12, 2024
24 tasks
Copy link
Member

@leifdenby leifdenby left a comment

Choose a reason for hiding this comment

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

Perfect! Thanks for adding the tests too! 🌟

@joeloskarsson joeloskarsson merged commit 6406833 into mllam:main Sep 18, 2024
3 checks passed
@joeloskarsson joeloskarsson deleted the coord_wise_refinement branch September 18, 2024 12:24
@leifdenby leifdenby added this to the v0.2.0 milestone Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outstanding questions
2 participants