flatspin-run

Run flatspin simulation.

usage: flatspin-run [-h] [-r {local,dist,none,worker}] [-p PARAM] [-m MODEL]
                    [-e ENCODER] [-o BASEPATH] [-f {csv,hdf,npy,npz}]
                    [--params-file PARAMS_FILE] [--list-params]
                    [--list-encoders] [--help-encoder] [--worker-id WORKER_ID]
                    [--num-workers NUM_WORKERS] [-V] [--show-plot]

-h, --help

show this help message and exit

-r {local,dist,none,worker}, --run {local,dist,none,worker}

run locally or distributed on a cluster

-p, --param

set model/run parameter key=value

-m <model>, --model <model>

name of model (default: SquareSpinIceClosed)

-e <encoder>, --encoder <encoder>

input encoder (type of external field, default: Sine)

-o <basepath>, --basepath <basepath>

output directory for results

-f {csv,hdf,npy,npz}, --format {csv,hdf,npy,npz}

format of output files (default: npz)

--params-file <params_file>

load parameters from file (params.csv), loaded before -p

--list-params

--list-encoders

--help-encoder

--worker-id <worker_id>

worker id

--num-workers <num_workers>

number of workers in total

-V, --version

display flatspin version

--show-plot

plot the state as the simulation runs