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

Suggestion in documentation enhancement #57

Closed
CSyl opened this issue Oct 9, 2024 · 1 comment
Closed

Suggestion in documentation enhancement #57

CSyl opened this issue Oct 9, 2024 · 1 comment
Assignees

Comments

@CSyl
Copy link

CSyl commented Oct 9, 2024

What maintenance does this project need?

Suggestions for doc. enhancements:

  1. Under https://anemoi-graphs.readthedocs.io/en/latest/usage/getting_started.html, the KNN method of build edges' argument of defining the number of nearest neighbors has been updated on both develop branch & main branch. Suggestion is to update the argument defining the number of nearest neighbors in the anemoi-graphs latest documentation from "nearest_neighbours" to "num_nearest_neighbours"

  2. Under https://anemoi-graphs.readthedocs.io/en/latest/graphs/node_attributes/weights.html, the "anemoi.graphs.nodes.nodes.ZarrDatasetNodeBuilder" & "anemoi.graphs.nodes.weights.Area" do not exist within the develop branch (weights.py does not exist) nor within the main branch of the source code (has weights.py, but the method is renamed to AreaWeights) so, the suggesting that the config. file shown in guide will need updates regarding those parameters.

Organisation

No response

@JPXKQX JPXKQX self-assigned this Oct 15, 2024
@JPXKQX
Copy link
Member

JPXKQX commented Oct 15, 2024

Thank you for raising these errors. They should be fixed with the next documentation release [docs].

@JPXKQX JPXKQX closed this as completed Oct 15, 2024
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

No branches or pull requests

2 participants