search

meom-group / jaxparrow

A package for computing the inversion of the cyclogeostrophic balance based on a variational formulation approach, using JAX.
https://jaxparrow.readthedocs.io/
Apache License 2.0
7 stars 1 forks source link

Add a short demo code snippet in the README.md #77

Open lesommer opened 3 months ago

lesommer commented 3 months ago

Ideally with a png image visible in the README.md file

vadmbertr commented 1 month ago

The snippet we currently have is not enough?

from jaxparrow import cyclogeostrophy, geostrophy

u_geos, v_geos = geostrophy(ssh_t=ssh,
                            lat_t=lat, lon_t=lon,
                            mask=mask)
u_cyclo, v_cyclo = cyclogeostrophy(ssh_t=ssh,
                                   lat_t=lat, lon_t=lon,
                                   mask=mask)