From b41a8a8dcfca2242a304a37efc05795515d88ea0 Mon Sep 17 00:00:00 2001 From: vitelot Date: Thu, 12 Sep 2024 17:20:52 +0200 Subject: [PATCH] new help text for the executables --- running/chelp.txt | 35 ++++++++++++++++++++++++++++++----- running/rhelp.txt | 20 ++++++++++++++++---- 2 files changed, 46 insertions(+), 9 deletions(-) diff --git a/running/chelp.txt b/running/chelp.txt index 46a433d..3f2041f 100644 --- a/running/chelp.txt +++ b/running/chelp.txt @@ -1,8 +1,16 @@ -usage: configure.jl [-d DATE] [-f FILE] - [--source_data_path SOURCE_DATA_PATH] - [--target_data_path TARGET_DATA_PATH] - [--select_line SELECT_LINE] [--pad_schedule] - [--rotations] [-h] +##################################### +############ CONFIGURE ############## +##################################### + +julia --project=../environment configure.jl -h +usage: strategies.jl [-d DATE] [-f FILE] + [--source_data_path SOURCE_DATA_PATH] + [--config_data_path CONFIG_DATA_PATH] + [--target_data_path TARGET_DATA_PATH] + [--select_line SELECT_LINE] + [--exo_delays EXO_DELAYS] [--delays_only] + [--use_real_time] [--pad_schedule] [--rotations] + [--cut_day] [--skip] [--reroute] [-h] optional arguments: -d, --date DATE Date from which we want to extract the @@ -12,6 +20,9 @@ optional arguments: --source_data_path SOURCE_DATA_PATH Source of the PAD timetable files. (default: "../preprocessing/data/") + --config_data_path CONFIG_DATA_PATH + Path of the data required by configure.jl + (default: "./data/") --target_data_path TARGET_DATA_PATH Folder to write processed data for the simulation. (default: "../simulation/data/") @@ -20,10 +31,24 @@ optional arguments: the list of ops from files in the source data path folder. E.g., --select_line NB-MI loads the file NB-MI.csv (default: "") + --exo_delays EXO_DELAYS + Number of files with exo delays to be created. + (type: Int64, default: 0) + --delays_only Skip *ALL* the configuration actions except + the sampling of delays. + --use_real_time Use the real time column of the PAD timetable + instead of the scheduled time. --pad_schedule Use the scheduled time in the PAD file instead of the scheduled time found in XML. --rotations Create a file with train dependencies. One train cannot start if the other has not arrived yet. + --cut_day Restrict the timetable to one day ignoring + trains over midnight. + --skip Used to skip parts of code for testing. [Not + yet used] + --reroute Reroute trains in the file + "configuration/data/trains-to-reroute.csv" to + an alternate path -h, --help show this help message and exit diff --git a/running/rhelp.txt b/running/rhelp.txt index 6893123..7243002 100644 --- a/running/rhelp.txt +++ b/running/rhelp.txt @@ -1,11 +1,17 @@ -usage: main.jl [-v] [-i INI] [-t TIMETABLE_FILE] [-b BLOCK_FILE] - [-s STATION_FILE] [--speed_test] [--multi_simulation] - [--catch_conflict] [--inject_delays] [-h] +Running the simulation with flags -h +julia --project=../environment main.jl -h +usage: main.jl [-v] [-i INI] [-o OUTPUT_PATH] [-t TIMETABLE_FILE] + [-b BLOCK_FILE] [-s STATION_FILE] [--speed_test] + [--multi_simulation] [--catch_conflict] + [--inject_delays] [--num_sims NUM_SIMS] [-h] optional arguments: -v, --version show the simulation's version -i, --ini INI path for the .ini file (default: - "../simulation/data/par.ini") + "../running/simdata/par.ini") + -o, --output_path OUTPUT_PATH + Folder where the generated timetables are to + be stored (default: "../running/results") -t, --timetable_file TIMETABLE_FILE override the path to the timetable file (default: "") @@ -30,5 +36,11 @@ optional arguments: If the --multi_simulation flag is not specified, the first ordered delay file is used. + --num_sims NUM_SIMS The number of simulations to carry out. This + number should at most be the number of + delay files available. By default the number + of simulations would be equal to the + total number of delay files. (type: Int64, + default: -1) -h, --help show this help message and exit