modelx module#

The top-level module modelx includes API functions. By convention, modelx is assigned to the name mx in the global namespace:

>> import modelx as mx

Attributes defined in the top level module.

models#

Alias for get_models(). Available for Python 3.7 or newer

Getting objects#

`get_models`()	Returns a dict that maps model names to models.
`get_object`(name[, as_proxy])	Get a modelx object from its full name.
`cur_model`([model])	Get and/or set the current model.
`cur_space`([space])	Get and/or set the current space of the current model.

`new_model`([name])	Create and return a new model.
`new_space`([name, bases, formula])	Create and return a new space in the current model.
`defcells`([space, name])	Decorator/function to create/update cells from Python functions.

`write_model`(model, model_path[, backup, ...])	Write model to files.
`zip_model`(model, model_path[, backup, ...])	Archive model to a zip file
`read_model`(model_path[, name])	Read model from files.
`restore_model`(path[, name, datapath])	Restore a model and return it.
`open_model`(path[, name, datapath])	Load a model saved from a file and return it.

`get_recursion`()	Returns formula recursion limit
`set_recursion`([maxdepth])	Set formula recursion limit.

`get_recalc`()	Return `True` if dependent values are recalculated, `False` if they are cleared.
`set_recalc`(recalc)	Set the recalculation option.

`setup_ipython`()	Set up IPython shell for modelx.
`restore_ipython`()	Restore IPython' default error message.

`get_error`()	Returns exception raised during last formula execution
`get_traceback`([show_locals])	Traces back the last formula error.
`trace_locals`([index])	Retuns the local variables of a formula execution in the last traceback.
`use_formula_error`([use])	Specifies whether to replace error raised during formula execution
`handle_formula_error`([handle])	Specifies whether to raise FormulaError