csdms

basic_modeling_interface.info module

Interface that describes a model and it’s input and output variables.

class basic_modeling_interface.info.BmiInfo[source]

Bases: object

Get metadata about a model.

Methods

get_component_name() Name of the component.
get_input_var_names() List of a model’s input variables.
get_output_var_names() List of a model’s output variables.
get_component_name()[source]

Name of the component.

Returns:

str

The name of the component.

Notes

/* C */
int get_component_name(void * self, char * name);
get_input_var_names()[source]

List of a model’s input variables.

Input variable names must be CSDMS Standard Names, also known as long variable names.

Returns:

list of str

The input variables for the model.

Notes

/* C */
int get_input_var_name_count(void * self, int * count);
int get_input_var_names(void * self, char ** names);
get_output_var_names()[source]

List of a model’s output variables.

Output variable names must be CSDMS Standard Names, also known as long variable names.

Returns:

list of str

The output variables for the model.

Notes

/* C */
int get_output_var_name_count(void * self, int * count);
int get_output_var_names(void * self, char ** names);