Models

A Model is an object that can be run. It is generally used to define algorithms or process.

A model has inputs, outputs and an internal state. Inputs and outputs are used to allow communication between environnement and models and between models. Internal state is used by the model itself but cannot be reached from outside. This internal step is generally used when user want to execute model step by step, each step depending on previous one.

To define model instructions, you need to define at least "step" instructions. To do that, you can use:

• set_step_code()

To use a Model, you also need to define set_code method that is able to extract inputs, outpus and step, init, ... from given source code.

Animate notification are not yet implemented.

To reset internal state, use init() method. To run one step, use step() method.

Two convenience methods, see run() and "call" can be used to reset internal state and run a given number of step (one by default)

By default, functions are generated for "init", "run" and "animate"

class openalea.core.model.IModel(**kwds)

animate(*args, **kwargs)

Like run but send notification at each step.

init(*args, **kwargs)

Reset internal state, fill namespace and run "init code" if defined.

run(*args, **kwargs)

Init model and run "nstep" step(s).

set_code(code)

extract and set inputs, outputs and functions from code. For example, if "code" is:

'''
input = a, b:int=5
output = c
'''
def step():
    c = a+b

you can extract input, output and step function. So, m = Model("m1") m.set_code(code)

is equivalent to

m = Model("m1") m.set_func_code("step", "c=a+b") m.inputs_info = [InputObj('a'), InputObj('b:int=5')] m.outputs_info = [OutputObj('c')]

set_func_code(fname, code)

Parameters:

• fname -- function name: "step", "init", "animate", ...
• code -- python source code

set_step_code(code)

convenience method equivalent to set_func_code("step", code)

step(*args, **kwargs)

run "step code" if defined.

stop(*args, **kwargs)

Stop execution.

dtype = None

mimetype = None

class openalea.core.model.Model(name=None, **kwds)

animate(*args, **kwds)

eval_value(value)

execute(code)

get_documentation()

Returns:a string with the documentation of the model

init(*args, **kwds)

inputs_from_ns(inputs, ns, *args, **kwargs)

output_from_ns(namespace)

Get outputs from namespace and set them inside self.outputs

Parameters:namespace -- dict where the model will search the outputs

repr_code()

run(*args, **kwds)

run_code(code, namespace)

set_code(code)

set_func_code(fname, code)

set_step_code(code)

step(*args, **kwds)

code

icon = ''

step_code

class openalea.core.model.PythonModel(**kwargs)

get_documentation()

Returns:a string with the documentation of the model

repr_code()

set_code(code)

default_name = 'Python'

dtype = 'Python'

mimetype = 'text/x-python'

Models API

A Model is an object that can be run. It is generally used to define algorithms or process.

A model has inputs, outputs and an internal state. Inputs and outputs are used to allow communication between environnement and models and between models. Internal state is used by the model itself but cannot be reached from outside. This internal step is generally used when user want to execute model step by step, each step depending on previous one.

To define model instructions, you need to define at least "step" instructions. To do that, you can use:

• set_step_code()

To use a Model, you also need to define set_code method that is able to extract inputs, outpus and step, init, ... from given source code.

Animate notification are not yet implemented.

To reset internal state, use init() method. To run one step, use step() method.

Two convenience methods, see run() and "call" can be used to reset internal state and run a given number of step (one by default)

By default, functions are generated for "init", "run" and "animate"