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

General info page for regional mom6 output #22

Open
chiaweh2 opened this issue Jun 14, 2024 · 4 comments
Open

General info page for regional mom6 output #22

chiaweh2 opened this issue Jun 14, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@chiaweh2
Copy link
Collaborator

this includes variables, file format, naming convention, grid design, and more. Please feel free to add in for more information that need to be needed. I will start a markdown placeholder in the feature-info branch later for anyone who is interested please feel free to contribute on that branch.

@chiaweh2 chiaweh2 added the enhancement New feature or request label Jun 14, 2024
@chiaweh2 chiaweh2 self-assigned this Jun 14, 2024
@chiaweh2
Copy link
Collaborator Author

chiaweh2 commented Jun 21, 2024

@chiaweh2
Copy link
Collaborator Author

@jbigman-NOAA I have created a placeholder branch for the regional mom6 documentation. Currently I found
https://mom-ocean.github.io
https://mom6.readthedocs.io/en/main/
https://cefi-regional-mom6.readthedocs.io/en/latest/Introduction.html
https://regional-mom6.readthedocs.io/en/latest/
These are related to regional mom6 or mom6 in general. All are quite extensive and detailed but not quite aiming for "regional mom6 data user". I think having a simplified documentation for the data user community like you mentioned would be helpful for sure.

However, this takes some writing skill and model expertises. I will put request help and try put in some of the things I know in the chapter. But please feel free to drop info or contribute on the document! And please feel free to let me know if you have any difficulty or question when contributing.

@chiaweh2 chiaweh2 added help wanted Extra attention is needed documentation Improvements or additions to documentation labels Jun 21, 2024
@chiaweh2
Copy link
Collaborator Author

chiaweh2 commented Jul 3, 2024

  • file naming scheme
  • description on grid scheme
  • available variables
  • available indexes

@chiaweh2
Copy link
Collaborator Author

The new model description branch is in feature-regionalmom6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
Status: In Progress
Development

No branches or pull requests

1 participant