pyOpenSci / software-submission

Submit your package for review by pyOpenSci here! If you have questions please post them here: https://pyopensci.discourse.group/
87 stars 31 forks source link

xnemogcm: Presubmission Inquiry #154

Closed rcaneill closed 4 months ago

rcaneill commented 4 months ago

Submitting Author: Romain Caneill (@rcaneill)
Package Name: xnemogcm One-Line Description of Package: Interface to open NEMO global circulation model output dataset with xarray and create a xgcm grid. Repository Link (if existing): https://github.com/rcaneill/xnemogcm/


Code of Conduct & Commitment to Maintain Package

Description

xnemogcm is an interface to open NEMO ocean global circulation model output dataset and create a xgcm grid. NEMO 3.6, 4.0, and 4.2.0 are tested and supported. It can handle large simulations, is aware of meshgrid files, and makes it easy to handle the netCDF outputs od NEMO.

Community Partnerships

We partner with communities to support peer review with an additional layer of checks that satisfy community requirements. If your package fits into an existing community please check below:

Scope

Domain Specific & Community Partnerships

xnemogcm extracts the NEMO output and adds metadata (+ do some other things as change coordinate names, etc), and produces new xarray datasets. It is thus data processing.

I checked the unsure/Other box as a more specific area is physical oceanography.

The target audience is anyone working with NEMO outputs and python. The scientific applications are any analyse that one want to do with NEMO outputs.

Yes, xorca. My package differs as 1) it is more recent, updated to work with newer versions of NEMO, and 2) it uses a very different method to sort variables on the proper grid point (center, face, etc) (cf https://xgcm.readthedocs.io/en/latest/grids.html). xorca uses hardcoded variables, while xnemogcm uses attributes (either output directly by NEMO, or they can also be given while calling the processing functions).

NickleDave commented 4 months ago

Hi @rcaneill xnemogcm is definitely in scope and I think we already have an editor for you :slightly_smiling_face: Please go ahead and make a full submission, and reference this issue when you do ("as discussed in #154")

rcaneill commented 4 months ago

Great news, I'll open the new issue ASAP :)