CODE CLINIC MEOM 10/04 - README

[Amine-ouhechou]

README

The README should include:

• The package name

• Short description of package goals.

• Package installation instructions

  • Brief demonstration of package usage (as it makes sense - links to vignettes could also suffice here if package description is clear)

• Link to your documentation website.

• If applicable, how the package compares to other similar packages and/or how it relates to other packages in the scientific ecosystem.

• Citation information

[lesommer]

Review by @Articoking & @lesommer :

• add a sentence explaining what wide-swath Altimetry refers to
• change “Widetrax : you tool…” —> “WideTrax : a Python package for handling wide-swath Altimetry data”
• change “powerful” —> “Python”
• change “effortlessly” —> “on both local and cloud resources”
• add installation instructions with a code snippet (w/ pip or mamba)
• add an exemple code snippet on how to open SWOT data from a s3 endpoint
• add an example code snippet showing how to compute a wave number spectra
• change “key features” —> “Functionalities”
• invert the order of feature 1 w/ feature 2
• add section on “related packages” mentioning the SWOT community GitHub organisation and jaxparrow
• add a section on where to find SWOT ocean data
• add citation information w/ , may be w/ a zenodo doi.
• What about a paper for JOSS ?