diff --git a/README.md b/README.md index e69de29..af4ada2 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +Simulation server cluster + +## How to use +usage: +``` +main.py [-h] [--simulation_time SIMULATION_TIME] [--num_runs NUM_RUNS] [--min_runs MIN_RUNS] [--confidence_level CONFIDENCE_LEVEL] [--best_c | --no-best_c] +``` + +options: +``` +-h, --help show help message and exit +--simulation_time SIMULATION_TIME runtime of each individual simulation +--num_runs NUM_RUNS number of simulations to run with a fixed set of parameters +--min_runs MIN_RUNS minimum number of successful runs needed to calculate statistics +--confidence_level CONFIDENCE_LEVEL confidence level +--best_c only run simulations for lambda=1 and determine the best C +``` + +#### default values: +Simulation time: 500 +Number of runs: 10 +Minimum number of runs: 5 +confidence level: 95% +best C (running simulation for lamba=1 only): False