search

rcaneill / xnemogcm

Interface to open NEMO global circulation model output dataset with xarray and create a xgcm grid.
https://xnemogcm.readthedocs.io/
MIT License
21 stars 9 forks source link

Add clarifying language to docs index page #93

Closed paigem closed 5 months ago

paigem commented 5 months ago

In general, I think the documentation of this package could be made a bit clearer. I make a few suggestions in this PR, particularly around the language used to describe the 3 examples. However, I haven't used NEMO data myself, so please review the wording I used and ensure that it is correct.

My main issue with this docs index page is that it assumes a high level of NEMO knowledge. I understand that most people who use this tool will be well-versed in the output files and structures of NEMO, but with just a little effort, these docs can also be helpful for people who are new to using NEMO.

For example, I don't actually know why it's important to "recombine" the domain_cfg and mesh_mask files (Example 2). I took a stab at explaining why this is necessary in this PR, but just a sentence motivating why this is useful for users would be very helpful.

rcaneill commented 5 months ago

(PS I fixed the pre-commit hook in another PR so no need to worry that the action is failing)

paigem commented 5 months ago

Thanks @rcaneill for your input here! I don't think I have the ability to merge, so I'll let you do the honors when you're ready.