bgc_md2 package

Submodules

bgc_md2.ModelDataObject module

bgc_md2.ModelDataObject.FluxRateDensityVariable2FluxRateVariable(frdv, dz)[source]
bgc_md2.ModelDataObject.FluxRateVariable2FluxVariable(frv, time)[source]
class bgc_md2.ModelDataObject.ModelDataObject(**keywords)[source]

Bases: object

create_discrete_model_run(errors=False)[source]
create_model_run(errors=False)[source]
get_acc_gross_external_input_flux(mr, pool_name, nr_layer=0, name='')[source]
get_acc_gross_external_output_flux(mr, pool_name, nr_layer=0, name='')[source]
get_acc_gross_internal_flux(mr, pool_name_from, pool_name_to, nr_layer_from=0, nr_layer_to=0, name='')[source]
get_dz(pool_name)[source]
get_stock(mr, pool_name, nr_layer=0, name='')[source]
load_external_input_fluxes(**keywords)[source]
load_external_output_fluxes(**keywords)[source]
load_horizontal_fluxes(**keywords)[source]
load_stocks(**keywords)[source]
load_vertical_fluxes(**keywords)[source]
load_xs_Us_Fs_Rs()[source]
exception bgc_md2.ModelDataObject.ModelDataObjectException[source]

Bases: Exception

bgc_md2.ModelDataObject.StockDensityVariable2StockVariable(sdv, dz)[source]
bgc_md2.ModelDataObject.getFluxVariable_from_DensityRate(**keywords)[source]
bgc_md2.ModelDataObject.getFluxVariable_from_Rate(**keywords)[source]
bgc_md2.ModelDataObject.getStockVariable_from_Density(**keywords)[source]
bgc_md2.ModelDataObject.readVariable(**keywords)[source]

bgc_md2.ModelStructure module

class bgc_md2.ModelStructure.ModelStructure(**keywords)[source]

Bases: object

get_external_input_flux_var(pool_name)[source]
get_external_output_flux_var(pool_name)[source]
get_flux_var_names()[source]
get_horizontal_flux_var(pool_from, pool_to)[source]
get_nr_layers(pool_name)[source]
get_nr_pools()[source]
get_pool_name_and_layer_nr(pool_nr)[source]
get_pool_nr(pool_name, layer_nr)[source]
get_pool_nrs(pool_name)[source]
get_pool_nrs_set(pool_names, layers)[source]
get_stock_var(pool_name)[source]
property pool_names
property stock_vars
exception bgc_md2.ModelStructure.ModelStructureException[source]

Bases: Exception

bgc_md2.Variable module

bgc_md2.Variable.FixDumbUnits(unit)[source]

Try to fix the dumb units people insist on using. :param unit: the trial unit :type unit: str

Returns

unit – the fixed unit

Return type

str

class bgc_md2.Variable.FluxVariable(**keywords)[source]

Bases: bgc_md2.Variable.Variable

aggregateInTime(nstep)[source]
class bgc_md2.Variable.StockVariable(**keywords)[source]

Bases: bgc_md2.Variable.Variable

class bgc_md2.Variable.Variable(**keywords)[source]

Bases: object

absolute_error(v_right)[source]
aggregateInTime(nstep)[source]
convert(tar_unit)[source]
data_mult(dim_var, given_axes)[source]
relative_error(v_right)[source]

bgc_md2.described_quantities module

bgc_md2.described_quantities.describedQuantity(name, dimension, description)[source]
bgc_md2.described_quantities.to_number(q, targetUnit)[source]

bgc_md2.helper module

class bgc_md2.helper.MvarSetInspectionBox(*args, **kwargs)[source]

Bases: ipywidgets.widgets.widget_box.VBox

create_notebook(model_name)[source]
update(model_name)[source]
class bgc_md2.helper.MvarSetListGridBox(*args, **kwargs)[source]

Bases: ipywidgets.widgets.widget_templates.GridspecLayout

inspect_mvs(name)[source]
populate()[source]
bgc_md2.helper.button_callback(function, *args)[source]
bgc_md2.helper.createSingleModelNb(model_name, report_file_path)[source]
bgc_md2.helper.createSingleModelNbFile(model_name)[source]
bgc_md2.helper.funcmakerInsertLinkInToBox(grid, name)[source]
bgc_md2.helper.list_models()[source]
bgc_md2.helper.list_models_md()[source]
bgc_md2.helper.modelVBox(model_name)[source]

Module contents