Sources

When configuring a simulation, you must specify the source for each supported class in the configuration to ensure it is correctly loaded into the simulator. Currently, there are two supported methods for specifying the source of these classes.

Local Files

You can specify the source as a local file by using the file:// prefix and appending a path relative to the base directory of the configuration.yaml. Note that only files within the same directory or its subdirectories can be used; files from parent directories are excluded, as they won't be uploaded.

Additionally, you must specify the directory containing the class, not a specific file within it. See the example below:

source: file://agent/simple_borrow_agent/

Library

The simulator also supports a library system (detailed documentation for this system is beyond the scope of the simulator's documentation). Instead of specifying a source as a file, you can use the library:// prefix along with the name of the library item, and optionally, a specific version, to have the simulator load that library item directly.

If no version is specified, the simulator will use the latest version of the item.

# version specified
source: library://very-cool-agent:v1.0.2
# no version specified
source: library://very-cool-agent