Coupling between models

AlgoComponents dedicated to the coupling between NWP models.

class vortex.nwp.algo.coupling.CouplingBaseDateNamMixin(*args, **kwargs)

Add a basedate attribute and make namelist substitution.

Note

The following documentation is automatically generated. From a developer point of view, using the present mixin class will result in the following actions:

The following footprints will be applied to the target classes:

Footprint:

dict( 
    attr = dict( 
        basedate = dict( 
            access = 'rxx',  
            alias = set([]),  
            default = None,  
            doc_visibility = footprints.priorities.PriorityLevel::DEFAULT (rank=0),  
            doc_zorder = 0,  
            info = 'The run date of the coupling generating process',  
            optional = True,  
            outcast = set([]),  
            remap = dict(),  
            type = bronx.stdtypes.date.Date,  
            values = set([]), 
        ), 
    ),  
    bind = [],  
    info = 'Not documented',  
    only = dict(),  
    priority = dict( 
        level = footprints.priorities.PriorityLevel::DEFAULT (rank=1), 
    ), 
) 

The following method(s) will be called after the original prepare method:

• <function CouplingBaseDateNamMixin._prepare_basedate_hook at 0x7b0e2b4a5300>

class vortex.nwp.algo.coupling.Coupling(*args, **kwargs)

Coupling for IFS-like LAM Models.

OBSOLETE a/c cy46 (use the 903 configuration / fullpos server instead).

class vortex.nwp.algo.coupling.CouplingLAM(*args, **kwargs)

Coupling for LAM to LAM Models (useless beyond cy40).

OBSOLETE a/c cy40.

class vortex.nwp.algo.coupling.PrepMixin(*args, **kwargs)

Coupling/Interpolation of Surfex files.

Note

The following documentation is automatically generated. From a developer point of view, using the present mixin class will result in the following actions:

The following footprints will be applied to the target classes:

Footprint:

dict( 
    attr = dict( 
        kind = dict( 
            access = 'rxx',  
            alias = set([]),  
            default = None,  
            doc_visibility = footprints.priorities.PriorityLevel::DEFAULT (rank=0),  
            doc_zorder = 0,  
            optional = False,  
            outcast = set([]),  
            remap = dict(),  
            values = set(['prep']), 
        ),  
        outputformat = dict( 
            access = 'rxx',  
            alias = set([]),  
            default = None,  
            doc_visibility = footprints.priorities.PriorityLevel::DEFAULT (rank=0),  
            doc_zorder = 0,  
            info = 'The format of output data (as expected by the user).If omited, same as input data.',  
            optional = True,  
            outcast = set([]),  
            remap = dict(),  
            values = set(['lfi', 'fa', 'netcdf', 'txt']), 
        ),  
        underlyingformat = dict( 
            access = 'rxx',  
            alias = set([]),  
            default = 'fa',  
            doc_visibility = footprints.priorities.PriorityLevel::DEFAULT (rank=0),  
            doc_zorder = 0,  
            info = 'The format of input data (as expected by the PREP executable).',  
            optional = True,  
            outcast = set([]),  
            remap = dict(),  
            values = set(['lfi', 'fa', 'netcdf']), 
        ),  
        underlyingoutputformat = dict( 
            access = 'rxx',  
            alias = set([]),  
            default = None,  
            doc_visibility = footprints.priorities.PriorityLevel::DEFAULT (rank=0),  
            doc_zorder = 0,  
            info = 'The format of output data (as expected by the PREP executable).If omited, *underlyingformat* is used.',  
            optional = True,  
            outcast = set([]),  
            remap = dict(),  
            values = set(['lfi', 'fa', 'netcdf', 'txt']), 
        ), 
    ),  
    bind = [],  
    info = 'Coupling/Interpolation of Surfex files.',  
    only = dict(),  
    priority = dict( 
        level = footprints.priorities.PriorityLevel::DEFAULT (rank=1), 
    ), 
) 

The following method(s) will be called after the original prepare method:

• <function PrepMixin._prepare_prep_hook at 0x7b0e2b4a5c60>

The following method(s) will be called after the original spawn_hook method:

• <function PrepMixin._spawn_hook_prep_hook at 0x7b0e2b4a5d00>

class vortex.nwp.algo.coupling.Prep(*args, **kwargs)

Coupling/Interpolation of Surfex files (non-MPI version).

class vortex.nwp.algo.coupling.ParallelPrep(*args, **kwargs)

Coupling/Interpolation of Surfex files (MPI version).

class vortex.nwp.algo.coupling.C901(*args, **kwargs)

Run of C901 configuration.

class vortex.nwp.algo.coupling.DomeoForcingAtmo(*args, **kwargs)

Correct the Domeo forcing file.