Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add differences with existing tools #103

Merged
merged 1 commit into from
Mar 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,16 @@ grid = xgcm.Grid(ds, metrics=get_metrics(ds), periodic=False)

The full documentation is hosted online:
[https://xnemogcm.readthedocs.io/](https://xnemogcm.readthedocs.io/)

## Differences with existing tools

There exist tools in Fortran that ship with NEMO that are used to create domain files,
input fields, etc. They are however more used to produce configurations with the
necessary input files, than to analyse the outputs. So there is only one overlap with
xnemogcm, which is recombining the mesh_mask / domaincfg files,
when they have been outputted by different processors.

NEMO output files are outputted as netcdf so they can directly be opened by xarray.
However, what is missing is all grid information in the shape needed by
xgcm (COMODO convention). To solve this problem, another python package
exists: xorca. However, xorca is not developed any more is less flexible than xnemogcm.
rcaneill marked this conversation as resolved.
Show resolved Hide resolved
Loading