Source code for pycif.plugins.domains.dalecbethy.create_domain

from ....utils.check.errclass import CifValueError




def create_domain(*args, **kwargs):
    """D&B's sample-point domain cannot be generated by pyCIF.

    Unlike CHIMERE's HCOORD/VCOORD grid, D&B's domain (its ``ng``
    grid-cells/sites and their PFT-derived ``nsp`` sample points) is not a
    regular grid pyCIF could build from a handful of geometry parameters:
    it is entirely defined by D&B's own static forcing NetCDF file
    (``input/staticforcing.nc``), produced externally, upstream of any
    pyCIF run (see ``model_sources/dalecbethy/src/ncread_forcing.f90::
    ncread_static_forcing``). Use :func:`~.read_domain.read_grid` instead.

    Raises:
        CifValueError: always.
    """
    raise CifValueError(
        "cannot generate a D&B (DALEC-BETHY) domain: the sample-point grid "
        "(ng/nsp, PFT composition, lon/lat, ...) is defined externally by "
        "D&B's own 'staticforcing.nc' file and must be read with "
        "'read_domain', not generated by pyCIF."
    )