Commandline Interface#

bucky#

Bucky CLI.

bucky [OPTIONS] COMMAND [ARGS]...

Options

-c, --cfg <cfg_path>#

Bucky cfg file/dir path.

-v, --verbose#

Enable INFO level logging.

Default:

False

-d, --debug#

Enable DEBUG level logging.

Default:

False

--no-color#

Disable colorized output.

--cpu#

Force numpy, otherwise cupy will be used if in it’s place (if installed).

Environment variables

BUCKY_CFG

Provide a default for --cfg

BUCKY_VERBOSE

Provide a default for --verbose

BUCKY_DEBUG

Provide a default for --debug

cfg#

bucky cfg [OPTIONS] COMMAND [ARGS]...

print#

bucky cfg print, print curretn cfg to stdout.

bucky cfg print [OPTIONS]

data#

bucky data [OPTIONS] COMMAND [ARGS]...

sync#

bucky data checkout, sync datasources into data_dir.

bucky data sync [OPTIONS]

run#

bucky run, run the default steps for a full model run (run model -> calculate quantiles -> make plots).

bucky run [OPTIONS] COMMAND [ARGS]...

Options

-d <days>#

Number of days to project forward

Default:

30

-s <seed>#

Global PRNG seed

Default:

42

-n <n_mc>#

Number of Monte Carlo iterations

Default:

100

--runid <run_id>#

UUID name of current run

Default:

2022-08-08__12_24_19

--start-date <start_date>#

Start date for the simulation. (YYYY-MM-DD)

model#

bucky run model, run the model itself, dumping raw monte carlo output to raw_output_dir.

bucky run model [OPTIONS]

Options

-d <days>#

Number of days to project forward

Default:

30

-s <seed>#

Global PRNG seed

Default:

42

-n <n_mc>#

Number of Monte Carlo iterations

Default:

100

--runid <run_id>#

UUID name of current run

Default:

2022-08-08__12_24_19

--start-date <start_date>#

Start date for the simulation. (YYYY-MM-DD)

postprocess#

bucky run postprocess, aggregate outputs from raw_output_dir to make quantile outputs in output_dir.

bucky run postprocess [OPTIONS]

Options

--run-dir <run_dir>#

Raw output directory for the run being postprocessed

-c <n_cpu>#

Number of cpus used to calculate quantiles

Default:

4

-g <n_gpu>#

Number of gpus used to calculate quantiles

viz#

bucky viz [OPTIONS] COMMAND [ARGS]...

plot#

bucky viz plot, produce matplotlib quantile plots from output files.

bucky viz plot [OPTIONS]

Options

--input-dir <input_dir>#

Directory of input data to plot

--output-dir <output_dir>#

Directory for created plots

-l, --levels <levels>#

Adm levels to generate plots of

Default:

adm0, adm1

Options:

adm0 | adm1 | adm2

-c, --columns <columns>#

Columns to plot

Default:

daily_reported_cases, daily_deaths

-np, --num_proc <num_proc>#

Number of parallel procs to use

Default:

-1

-nh, --nhist <n_hist>#

Number of historical days to include in plot

Default:

28

-w, --window <hist_window_size>#

Window size for rolling mean of plotted historical data points

Default:

7

--plot_hist#

Plot historical data points

Default:

True

--plot_fit#

Plot historical data fit

Default:

True

--adm-mapping-file <adm_mapping_file>#

Location of admin mapping file