search

DocOtak / gsw-xarray

Wrapper for gsw that will add CF attributes to xarray.DataArray outputs
https://gsw-xarray.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
23 stars 3 forks source link

Script to parse units and name #28

Open rcaneill opened 2 years ago

rcaneill commented 2 years ago

This PR is not meant to be merged, just to keep somewhere the script I wrote to parse units and name from the matlab doc.

rcaneill commented 2 years ago

Here is the output for the first 10 functions of gsw, sweet :) (of course, it will still imply some work by hand...)

{'CT_first_derivatives': {'units': 'K/(g/kg)'}, 'CT_first_derivatives_wrt_t_exact': {'units': 'K/(g/kg)'}, 'CT_freezing': {'units': 'degC'}, 'CT_freezing_first_derivatives': {'units': 'K/(g/kg)'}, 'CT_freezing_first_derivatives_poly': {'units': 'K/(g/kg)'}, 'CT_freezing_poly': {'units': 'degC'}, 'CT_from_enthalpy': {'units': 'degC'}, 'CT_from_enthalpy_exact': {'units': 'degC'}, 'CT_from_entropy': {'units': 'degC'}, 'CT_from_pt': {'units': 'degC'}}
{'CT_first_derivatives': 'CT', 'CT_first_derivatives_wrt_t_exact': 'CT', 'CT_freezing': 'CT', 'CT_freezing_first_derivatives': 'CTfreezing', 'CT_freezing_first_derivatives_poly': 'CTfreezing', 'CT_freezing_poly': 'CT', 'CT_from_enthalpy': 'CT', 'CT_from_enthalpy_exact': 'CT', 'CT_from_entropy': 'CT', 'CT_from_pt': 'CT'}
DocOtak commented 2 years ago

I think it would be OK to have these type of scripts merged into the main repo as long as they are separate from the installable distribution. Maybe a little readme saying that these were basically dev scripts used to generate other parts of the code/data, that they are not "maintained" or really meant to be used.

rcaneill commented 2 years ago

Ok, I'll merge (+ small doc) with the next update of the script (when I will parse the inputs units / names)