Skip to content
/ NDSL Public
forked from NOAA-GFDL/NDSL

NOAA NASA Domain Specific Language middleware layer

Notifications You must be signed in to change notification settings

fmalatino/NDSL

 
 

Repository files navigation

Lint Unit tests

NOAA/NASA Domain Specific Language middleware

NDSL is a middleware for climate and weather modelling developed jointly by NOAA and NASA. The middleware brings together GT4Py (the cartesian flavor), ETH CSCS's stencil DSL, and DaCE, ETH SPCL's data flow framework, both developed for high-performance and portability. On top of those pillars, NDSL deploys a series of optimized APIs for common operations (Halo exchange, domain decomposition, MPI...), a set of bespoke optimizations for the models targeted by the middleware and tools to port existing models.

Battery-included for FV-based models

Historically NDSL was developed to port the FV3 dynamical core on the cube-sphere. Therefore, the middleware ships with ready-to-execute specialization for models based on cube-sphere grid and FV-based model in particular.

Quickstart

Recommended Python is 3.11.x all other dependencies will be pulled during install.

NDSL submodules gt4py and dace to point to vetted versions, use git clone --recurse-submodule.

NDSL is NOT available on pypi. Installation of the package has to be local, via pip install ./NDSL (-e supported). The packages has a few options:

  • ndsl[test]: installs the test packages (based on pytest)
  • ndsl[develop]: installs tools for development and tests.

Tests are available via:

  • pytest -x test: running CPU serial tests (GPU as well if cupy is installed)
  • mpirun -np 6 pytest -x test/mpi: running CPU parallel tests (GPU as well if cupy is installed)

Requirements & supported compilers

For CPU backends:

  • 3.11.x >= Python < 3.12.x
  • Compilers:
    • GNU 11.2+
  • Libraries:
    • Boost headers 1.76+ (no lib installed, just headers)

For GPU backends (the above plus):

  • CUDA 11.2+
  • Python package:
  • Libraries:
    • MPI compiled with cuda support

Development

TBD: Code/contribution guideline

TBD: Documentation

Point of Contacts:

  • NOAA: Rusty Benson: rusty.benson -at- noaa.gov
  • NASA: Florian Deconinck florian.g.deconinck -at- nasa.gov

About

NOAA NASA Domain Specific Language middleware layer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%