mass.example_data

Module containing functions for loading various examples.

Package Contents

Functions

create_example_model(model_name[, io])

Return an example mass.MassModel.

view_example_models()

Print the example models that can be loaded.

view_example_maps()

Print the example models that can be loaded.

Attributes

FILE_EXTENSIONS

list of recognized file extensions.

MODELS_DIR

The directory location of the pre-built MassModel files.

MAPS_DIR

The directory location of the pre-made escher maps files.

mass.example_data.FILE_EXTENSIONS = ['.xml', '.json'][source]

list of recognized file extensions.

Type

list

mass.example_data.MODELS_DIR[source]

The directory location of the pre-built MassModel files.

Type

str

mass.example_data.MAPS_DIR[source]

The directory location of the pre-made escher maps files.

Type

str

mass.example_data.create_example_model(model_name, io='json')[source]

Return an example mass.MassModel.

Parameters
  • model_name (str) – The name of the example model to load. Valid model names can be printed and viewed using the view_example_models() function.

  • io (str {'sbml', 'json'}) – A string representing the mass.io module to use to load the model. Default is "sbml". Case sensitive.

Returns

The loaded MassModel

Return type

MassModel

mass.example_data.view_example_models()[source]

Print the example models that can be loaded.

mass.example_data.view_example_maps()[source]

Print the example models that can be loaded.