Added section describing repository audience#474
Added section describing repository audience#474Subhransu37 wants to merge 2 commits intomllam:mainfrom
Conversation
|
@Subhransu37 The PR description still contains some of the template placeholder text, and there is no linked issue/task yet. It would help reviewers if the final body only kept the actual motivation/scope for this README change. |
Thank you for the feedback. I have cleaned up the PR description. |
|
@Subhransu37 I am a bit conflicted about this suggestion, because mllam has evolved a lot over time. It has been used for ocean and space modeling, as well as high res simulation of eddies and more. I think I prefer having a clear and well strucured docs #252 / #61 instead of defining a target audience. Then everyone can decide for themselves if mllam is useful to them. Leaving this open as a draft for discussion with @joeloskarsson and @observingClouds. |
|
I agree with you @sadamov. We could rather add a Publication section, where we can list work done with neural-lam, so that new users see what the repo has been used for. |
observingClouds
left a comment
There was a problem hiding this comment.
Thanks for this PR. Based on the comments, we would rather like to have a section about publications that used neutral-lam than describing the audience explicitly.
|
Hi, I’ve been following this discussion. |
|
Just a publication section is all we need. Let's give @Subhransu37 a chance to adjust their PR though. |
Description
Added a new section in the README titled “Who is this repository for?”.
This section helps new users quickly understand the target audience of Neural-LAM and how beginners can get started with the project.
Type of change
📖 Documentation improvement
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee