Run module#
AequilibraE provides a convenient method for defining model entry points and their default
arguments via run/__init__.py and parameters.yml respectively. These can be used to
couple model parameters and methods to run models to the model itself.
run/__init__.py#
The run module is a standard Python module that is dynamically imported when the project.run
property is accessed. Objects named within parameters.yml under the run heading will have
their arguments partially applied via functools.partial and return a namedtuple.
Not all objects within the module must be named parameters.yml. If an object is named within
parameters.yml, then it must exist within the module otherwise a RuntimeError will be
raised.
By default an AequilibraE project comes with four example functions: matrix_summary,
graph_summary, results_summary, and example_function_with_kwargs. The summary functions
are not named within the default parameters.yml as they take no arguments.
Functions should use the get_active_project() function to obtain a reference to the current
project.
State within the module should be avoided as the file may be run multiple times.
Command line interface#
Functions in the run module can also be invoked from the command line via the aeq entry
point. aeq run --help lists the available functions, and each function accepts arguments
derived from its signature, with the defaults from parameters.yml pre-applied
(--no-defaults disables this).
aeq -p /path/to/project run --help
aeq -p /path/to/project run example_function_with_kwargs --help
aeq -p /path/to/project run example_function_with_kwargs --arg1 hello iterations=50
Required parameters become positional arguments and parameters with defaults become
--options. Parameters whose default value is a boolean become --flag/--no-flag
pairs, and functions accepting **kwargs take trailing key=value pairs. All values are
parsed as Python literals where possible and kept as strings otherwise, mirroring how
parameters.yml values are typed; quote a value (e.g. '"101"') to force a string. Type
annotations are shown in the help text but not enforced. If -p/--project is omitted the
current directory is used.
Run module