xnemogcm

Interface to open NEMO global circulation model output dataset with xarray and create a xgcm grid.

https://github.com/rcaneill/xnemogcm

Science Score: 77.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
✓
Committers with academic emails
1 of 6 committers (16.7%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords

nemo-ocean python xarray xgcm

Keywords from Contributors

mesh sequences interactive hacking network-simulation

Last synced: 6 months ago · JSON representation ·

Repository

Interface to open NEMO global circulation model output dataset with xarray and create a xgcm grid.

Basic Info

Host: GitHub
Owner: rcaneill
License: mit
Language: Python
Default Branch: main
Homepage: https://xnemogcm.readthedocs.io/
Size: 1.94 MB

Statistics

Stars: 22
Watchers: 1
Forks: 11
Open Issues: 1
Releases: 8

Topics

nemo-ocean python xarray xgcm

Created about 6 years ago · Last pushed 8 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

xnemogcm

python versions anaconda badge

Interface to open NEMO ocean global circulation model output as an Xarray Dataset and create a xgcm grid. NEMO 3.6, 4.0, 4.2.0, and 5.0 are tested and supported. Any version between 3.6 and 5.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

Name: Romain Caneill
Login: rcaneill
Kind: user
Location: Grenoble, France
Company: Institut des Géosciences de l'Environnement

Website: romaincaneill.fr
Repositories: 48
Profile: https://github.com/rcaneill

Doctor in Physical Oceanography. Studying sea ice, ocean stratif, buoyancy fluxes, nonlinear EOS, with numerical modelling (NextSIM, NEMO) and observations.

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

Release event: 3
Delete event: 11
Issue comment event: 8
Push event: 11
Pull request event: 23
Fork event: 1
Create event: 14

Last Year

Release event: 3
Delete event: 11
Issue comment event: 8
Push event: 11
Pull request event: 23
Fork event: 1
Create event: 14

Committers

Last synced: over 1 year ago

All Time

Total Commits: 250
Total Committers: 6
Avg Commits per committer: 41.667
Development Distribution Score (DDS): 0.148

Past Year

Commits: 74
Committers: 5
Avg Commits per committer: 14.8
Development Distribution Score (DDS): 0.419

Top Committers

Name	Email	Commits
Romain	r**l@y**r	213
Romain	r**l@z**t	15
Callum Rollo	c**o@o**m	11
dependabot[bot]	4****]	6
David Kamm	d**m@p**r	3
Paige Martin	p**r@u**u	2

Committer Domains (Top 20 + Academic)

umich.edu: 1 porphyrion.locean-ipsl.upmc.fr: 1 zaclys.net: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 25
Total pull requests: 121
Average time to close issues: 4 months
Average time to close pull requests: 12 days
Total issue authors: 7
Total pull request authors: 8
Average comments per issue: 1.4
Average comments per pull request: 0.53
Merged pull requests: 77
Bot issues: 0
Bot pull requests: 53

Past Year

Issues: 0
Pull requests: 26
Average time to close issues: N/A
Average time to close pull requests: 5 days
Issue authors: 0
Pull request authors: 3
Average comments per issue: 0
Average comments per pull request: 0.65
Merged pull requests: 11
Bot issues: 0
Bot pull requests: 13

View more stats

Top Authors

Issue Authors

rcaneill (15)
paigem (3)
callumrollo (2)
ocefpaf (1)
bguelk (1)
atb299 (1)
rabernat (1)
vopikamm (1)

Pull Request Authors

rcaneill (75)
dependabot[bot] (58)
callumrollo (10)
github-actions[bot] (7)
noemieplanat (2)
paigem (2)
ocefpaf (1)
vopikamm (1)

Top Labels

Issue Labels

enhancement (4) bug (4) question (1)

Pull Request Labels

dependencies (58) python (9)

Packages

Total packages: 2
Total downloads:
- pypi 61 last-month

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 1
(may contain duplicates)
Total versions: 16
Total maintainers: 1

pypi.org: xnemogcm

Interface to open NEMO global circulation model output dataset and create a xgcm grid.

Homepage: https://github.com/rcaneill/xnemogcm
Documentation: https://xnemogcm.readthedocs.io/
License: MIT
Latest release: 0.5.0
published about 1 year ago

Versions: 15
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 61 Last month

Rankings

Dependent packages count: 10.1%

Forks count: 13.3%

Stargazers count: 13.7%

Average: 18.6%

Dependent repos count: 21.6%

Downloads: 34.4%

Maintainers (1)

rcaneill

Last synced: 6 months ago

conda-forge.org: xnemogcm

Homepage: https://github.com/rcaneill/xnemogcm
License: MIT
Latest release: 0.3.4
published almost 4 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 34.0%

Average: 47.8%

Dependent packages count: 51.2%

Stargazers count: 51.9%

Forks count: 54.2%

Last synced: 6 months ago

Dependencies

pyproject.toml pypi

black ^22.10.0
dask *
f90nml >=1.3.1
jupyterlab >=3.5.1
netcdf4 >=1.5.8
pytest >=6.2.5
python >=3.8
xarray >=0.21.1
xgcm >=0.6.0

.github/workflows/ci_upgrade_dependencies.yml actions

abatilo/actions-poetry v2.0.0 composite
actions/checkout v2 composite
actions/setup-python v1 composite

.github/workflows/publish.yml actions

JRubics/poetry-publish v1.13 composite
actions/checkout v2 composite

poetry.lock pypi

119 dependencies

.github/workflows/ci.yml actions

abatilo/actions-poetry v2.0.0 composite
actions/checkout v2 composite
actions/setup-python v2 composite
actions/setup-python v1 composite

.github/workflows/ci_run_notebook.yml actions

abatilo/actions-poetry v2.0.0 composite
actions/checkout v2 composite
actions/setup-python v2 composite
peter-evans/create-pull-request v4 composite

xnemogcm

Science Score: 77.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

xnemogcm

Installation

Usage

Interface with xgcm

Differences with existing tools

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: xnemogcm

Rankings

Maintainers (1)

conda-forge.org: xnemogcm

Rankings

Dependencies