FMS, an agent-based Financial Market Simulator

startfms

the startfms.py launching script

Manual section:1
Manual group:FMS - a financial market simulator
Date:2009-01-24
Author:Jean-Charles Bagneris

SYNOPSIS

startfms.py [options] [command] [experiment-config-file]

DESCRIPTION

FMS is an agent-based market simulator. The main program, startfms.py can read and validate an “experiment” config file, and/or run it, outputting transactions data on stdout or in a .csv file.

The experiment configuration file is described in experiment-conf.yml(5) or in the html documentation.

OPTIONS

Options override parameters values.

-h, --help Show help message and quit.
--version Report FMS version.
-L LEVEL, --loglevel LEVEL
 Set logging level to LEVEL. This overrides the -v option.
--verbose, -v Set logging level to ‘info’. Overrided by -L or –loglevel option.
--show_books, --show_limits
 Show best limits on each step.
--timer Show a day:time timer while experiment is running.
--unique_by_agent
 Orders in books are unique by agent : if the same agent places another order, previous one is deleted. This is the default.
--no_unique_by_agent
 Agents may place multiple orders.
--csvdelimiter DELIMITER
 CSV files delimiter value.
--randomseed SEED
 Ramdom seed value.
--outputfilename OUTPUTFILE, -o OUTPUTFILE
 Set output filename to OUTPUTFILE. This overrides the outpufilename parameter in experiment config file.
--orderslogfile FILENAME, --ordersfile FILENAME
 Set orders logfile name to FILENAME. This overrides the orderlogfilename parameter in experiment config file.
--repeat NUM Repeat the experiment NUM times.

COMMANDS

check
Checks validity of experiment-config-file by trying to instanciate all classes : world, engines, markets and agents.
run
Run experiment from experiment-config-file.

SEE ALSO

experiment-conf.yml(5) or the html documentation.

BUGS

Probably many.

Table Of Contents

Previous topic

FMS tutorial

Next topic

FMS experiments configuration

This Page