scml.cliadv

The SCML universal command line tool

Module Contents

Functions

gui_option(x)
get_range(x, x_min, x_max)	Gets a range with possibly overriding it with a single value
default_log_path()	Default location for all logs
default_tournament_path()	The default path to store tournament run info
default_world_path()	The default path to store world run info
print_progress(→ None)	Prints the progress of a tournament
print_world_progress(→ None)	Prints the progress of a world
cli()
tournament(ctx, ignore_warnings)
create(ctx, name, steps, ttype, timeout, log, ...)
run(ctx, name, verbosity, parallel, distributed, ip, ...)
display_results(results, metric)
_path(→ pathlib.Path)	Creates an absolute path from given path which can be a string
run2019(steps, levels, neg_speedup, negotiator, ...)
run2020(force_signing, batch_signing, steps, ...)
version()

Attributes

n_completed
n_total

scml.cliadv.gui_option(x)

scml.cliadv.n_completed = 0

scml.cliadv.n_total = 0

scml.cliadv.get_range(x, x_min, x_max)

Gets a range with possibly overriding it with a single value

scml.cliadv.default_log_path()

Default location for all logs

scml.cliadv.default_tournament_path()

The default path to store tournament run info

scml.cliadv.default_world_path()

The default path to store world run info

scml.cliadv.print_progress(_, i, n) → None

Prints the progress of a tournament

scml.cliadv.print_world_progress(world) → None

Prints the progress of a world

scml.cliadv.cli()

scml.cliadv.tournament(ctx, ignore_warnings)

scml.cliadv.create(ctx, name, steps, ttype, timeout, log, verbosity, reveal_names, runs, configs, max_runs, competitors, world_config, non_competitors, compact, factories, agents, log_ufuns, log_negs, raise_exceptions, steps_min, steps_max, path, cw, inputs, inputs_min, inputs_max, outputs, outputs_min, outputs_max, costs, costs_min, costs_max, increasing_costs, equal_exogenous_supplies, equal_exogenous_sales, profit_mean, profit_std, productivity, productivity_min, productivity_max, cash_availability, cash_availability_min, cash_availability_max, buy_missing, borrow, bankruptcy_limit, penalty, reports, interest, force_exogenous, borrow_to_produce, balance, processes, factories_min, factories_max, horizon)

scml.cliadv.run(ctx, name, verbosity, parallel, distributed, ip, port, compact, path, log, metric)

scml.cliadv.display_results(results, metric)

scml.cliadv._path(path) → pathlib.Path

Creates an absolute path from given path which can be a string

scml.cliadv.run2019(steps, levels, neg_speedup, negotiator, agents, horizon, min_consumption, max_consumption, transport, time, neg_time, neg_steps, sign, guaranteed, lines, retrials, use_consumer, max_insurance, riskiness, competitors, log, compact, log_ufuns, log_negs, reserved_value, balance, shared_profile, raise_exceptions, path, world_config)

scml.cliadv.run2020(force_signing, batch_signing, steps, processes, neg_speedup, factories, factories_min, factories_max, horizon, time, neg_time, neg_steps, lines, competitors, log, compact, log_ufuns, log_negs, balance, raise_exceptions, path, world_config, inputs, inputs_min, inputs_max, outputs, outputs_min, outputs_max, costs, costs_min, costs_max, increasing_costs, equal_exogenous_supplies, equal_exogenous_sales, profit_mean, profit_std, productivity, productivity_min, productivity_max, cash_availability, cash_availability_min, cash_availability_max, buy_missing, borrow, bankruptcy_limit, penalty, reports, interest, force_exogenous, borrow_to_produce, show_contracts)

scml.cliadv.version()