Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: noemieplanat
- License: mit
- Language: Python
- Default Branch: main
- Size: 313 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
xnemogcm
Interface to open NEMO ocean global circulation model output as an Xarray Dataset and create a xgcm grid. NEMO 3.6, 4.0, and 4.2.0 are tested and supported. Any version between 3.6 and 4.2.0 should work, but in case of trouble, please open an issue.
If you wish to contribute but don't have a github account, send me an email with your questions or comments: romain [dot] caneill [at] ens-lyon [.] org
Installation
For conda
shell
conda install --channel conda-forge xnemogcm
for pip
shell
pip install xnemogcm
Usage
```python from pathlib import Path from xnemogcm import opennemoanddomaincfg
ds = opennemoanddomaincfg( nemofiles='/path/to/output/files', domcfgfiles='/path/to/domaincfg/meshmask/files' )
Interface with xgcm
from xnemogcm import getmetrics import xgcm grid = xgcm.Grid(ds, metrics=getmetrics(ds), periodic=False) ```
The full documentation is hosted online: 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 and is less flexible than xnemogcm. xnemogcm is meant to replace xorca, in addition to extending its functionality.
Owner
- Login: noemieplanat
- Kind: user
- Repositories: 1
- Profile: https://github.com/noemieplanat
Citation (CITATION.cff)
cff-version: 1.2.0
title: xnemogcm
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Romain
family-names: Caneill
email: romain.caneill@ens-lyon.org
orcid: 'https://orcid.org/0000-0001-6649-4275'
- given-names: David
family-names: Kamm
orcid: 'https://orcid.org/0009-0006-2210-3715'
- given-names: Callum
family-names: Rollo
orcid: 'https://orcid.org/0000-0002-5134-7886'
- given-names: Paige
family-names: Martin
orcid: 'https://orcid.org/0000-0003-3538-633X'
identifiers:
- type: doi
value: 10.5281/zenodo.5724577
repository-code: 'https://github.com/rcaneill/xnemogcm'
abstract: >-
Interface to open NEMO ocean global circulation model
output as an Xarray Dataset and create a xgcm grid.
license: MIT
GitHub Events
Total
Last Year
Dependencies
- 149 dependencies
- black ^22.10.0 develop
- jupyterlab >=3.5.1 develop
- pre-commit ^3.6.2 develop
- mkdocs ^1.5.3 docs
- mkdocs-jupyter ^0.24.6 docs
- mkdocstrings ^0.24.0 docs
- dask *
- f90nml >=1.3.1
- netcdf4 >=1.5.8
- pre-commit ^3.6.2
- python >=3.9
- xarray >=0.21.1
- xgcm >=0.6.0
- f90nml >=1.3.1 test
- pytest >=6.2.5 test
- toml ^0.10.2 test
- xgcm >=0.6.0 test