Uxarray Quality of Life Improvements

[anissa111]

Hello! Following a discussion with @michaelavs and @erogluorhan, here is a discussion post for collaborator input on some quality of life improvements we've discussed.

Feel free to comment on or add your own!

[anissa111]

Regarding code refactoring, see #86 for some of @erogluorhan's suggestions and feel free to expand that on as you see fit.

[anissa111]

Removing unimplemented functions, as the draft API is now included in the repo.

[anissa111]

Improving testing coverage. See #52 for more proposed detail

[erogluorhan]

Uxarray Usage examples issue is a good one for this!

[anissa111]

General documentation improvement, including examples and making sure the pages are rendering correctly as a condition for PR approval

[anissa111]

A reorganization of the helpers.py function.

• rename to util.py?
• pull out groups of connected functions that could have their own file, like the jacobian functions

[erogluorhan]

Contributor's Guide is also one thing that needs to be put together soon!

[anissa111]

Creation of a better storage area for testing files, similar to xarray.testing or geocat-datafiles

[anissa111]

I would also really like a function like Grid.__str__ that allows for formatted printing of class variables without needing to know the cf convention names to access

[rajeeja]

How about just using Grid.ds ?

[anissa111]

Yeah! I think something like that would definitely work. This is a relatively minor point anyway, but I think it'd be cool if we could have something (possibly just Grid.ds, possibly more) that prints out if we do a print(ux_grid) type call

[dcherian]

👍 for __repr__ and _repr_html_ Nobody actually coded it up but here are ideas we discussed for xgcm: xgcm/xgcm#276