Skip to content

Added section describing repository audience#474

Open
Subhransu37 wants to merge 2 commits intomllam:mainfrom
Subhransu37:improve-readme
Open

Added section describing repository audience#474
Subhransu37 wants to merge 2 commits intomllam:mainfrom
Subhransu37:improve-readme

Conversation

@Subhransu37
Copy link
Copy Markdown

@Subhransu37 Subhransu37 commented Mar 21, 2026

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

  • 🐛 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 README 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). This applies only if you have write access to the repo, otherwise feel free to tag a maintainer to add a reviewer and assignee.

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
    • maintenance: when your contribution is relates to repo maintenance, e.g. CI/CD or documentation

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • (if the PR is not just maintenance/bugfix) the PR is assigned to the next milestone. If it is not, propose it for a future milestone.
  • author has added an entry to the changelog (and designated the change as added, changed, fixed or maintenance)
  • Once the PR is ready to be merged, squash commits and merge the PR.

@kshirajahere
Copy link
Copy Markdown
Contributor

@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.

@Subhransu37
Copy link
Copy Markdown
Author

@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.

@sadamov sadamov added discussion documentation Improvements or additions to documentation labels Mar 23, 2026
@sadamov
Copy link
Copy Markdown
Collaborator

sadamov commented Mar 23, 2026

@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.

@sadamov sadamov marked this pull request as draft March 23, 2026 05:24
@observingClouds
Copy link
Copy Markdown
Contributor

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.

@Subhransu37 Subhransu37 marked this pull request as ready for review March 24, 2026 18:16
@observingClouds observingClouds self-requested a review March 25, 2026 05:06
Copy link
Copy Markdown
Contributor

@observingClouds observingClouds left a comment

Choose a reason for hiding this comment

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

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.

@HetaviM29
Copy link
Copy Markdown

Hi, I’ve been following this discussion.
Based on the suggestion to replace the audience section with a Publications section, I’d like to work on adding a structured Publications & Applications section in the README. I’m planning to organize it by application domains and include short descriptions for clarity.Does this approach align with your expectations?

@observingClouds
Copy link
Copy Markdown
Contributor

Just a publication section is all we need. Let's give @Subhransu37 a chance to adjust their PR though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

discussion documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants