Skip to content

clarification of coupling/component properties between science and software packages #33

Description

@bnlawrence

The original language and separation of concerns between coupled components, realms, and internal components has gotten rather unclear:

The science.model component includes the following properties

...
 ('realms', 'linked_to(science.realm)', '0.N',
      "The scientific realms which this model simulates internally, i.e. those which are not linked together using a coupler."),
('realm_coupling', 'science.realm_coupling', '0.N',
       "Description of a coupling between realms"),
# TODO: review these attributes once software package is peer-reviewed
('coupled_components', 'linked_to(science.model)', '0.N',
     "Software components which are linked together using a coupler to deliver this model."),
 ('coupler', 'software.coupling_framework', '0.1',
      "Overarching coupling framework for model."),
 ('internal_software_components', 'software.software_component', '0.N',
       "Software modules which together provide the functionality for this model."),

and the software.component has

...
('sub_components', 'software.software_component', '0.N',
       "Internal software sub-components of this component."),
('depends_on', 'software.software_component', '0.N',        # added dch/ssw 1016-0804
       "The software components whose outputs are inputs to this software component."),
# Would like to think about making this a stand-alone document

and we also have the science.realm_coupling class with properties

('variable', 'str', '1.1',
      'The variable being coupled (e.g. 10 metre wind)'),
('source_realm', 'str', '1.1',
      'The model realm providing the variable (e.g. ocean)'),
('target_realm', 'str', '1.1',
      'The model realm receiving the variable (e.g. atmosphere)'),
('time_frequency', 'str', '1.1',
      'The time frequency of the coupling (e.g. 1 hour)'),
('coupling_details', 'str', '0.1',
      'Description of the coupling algorithm, and any other information (e.g. binlinear interpolation')

Metadata

Metadata

Assignees

Labels

cimv3For consideration in a major release

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions