Commands¶
coinflip¶
Randomness tests for RNG output.
Output of random number generators can be parsed and serialised into a test-ready format via the load command. The data is saved in a folder, which coinflip refers to as a “store”. This store is located in the local data directory, but can be easily accessed via the store’s name in coinflip commands.
Randomness tests can then be ran over the store’s data via the run command. Rich documents explaining the test results can be produced via the report command.
coinflip [OPTIONS] COMMAND [ARGS]...
Commands
-
cat
Print contents of data in STORE.
-
example-run
Run randomness tests on example data.
-
load
Loads DATA into a store.
-
local-run
Run randomness tests on DATA directly.
-
ls
List all stores.
-
report
Generate html report from test results in…
-
rm
Delete STORE.
-
rm-all
Delete all stores.
-
run
Run randomness tests on data in STORE.
coinflip load¶
Loads DATA into a store.
DATA is a newline-delimited text file which contains output of a random number generator. The contents are parsed, serialised and saved in local data.
The stored data can then be applied the randomness tests via the run command, where the results of which are also saved.
coinflip load [OPTIONS] DATA
Options
-
-n
,
--name
<name>
¶ Specify name of the store.
-
-d
,
--dtype
<dtype>
¶ Specify data type of the data.
Options: bool|byte|short|int|long|float|double
-
-o
,
--overwrite
¶
Overwrite existing store with same name.
Arguments
-
DATA
¶
Required argument
coinflip cat¶
Print contents of data in STORE.
coinflip cat [OPTIONS] STORE
Arguments
-
STORE
¶
Optional argument
coinflip run¶
Run randomness tests on data in STORE.
Results of the tests run are saved in STORE, which can be compiled into a rich document via the report command.
coinflip run [OPTIONS] STORE
Options
-
-t
,
--test
<test>
¶ Specify single test to run on data.
Options: monobit|frequency_within_block|runs|longest_runs|binary_matrix_rank|spectral|non_overlapping_template_matching|overlapping_template_matching|maurers_universal
Arguments
-
STORE
¶
Optional argument
coinflip example-run¶
Run randomness tests on example data.
coinflip example-run [OPTIONS]
Options
-
-e
,
--example
<example>
¶ Example binary output to use.
Options: python|primes
-
-n
,
--length
<length>
¶ Length of binary output.
-
-t
,
--test
<test>
¶ Specify single test to run on data.
Options: monobit|frequency_within_block|runs|longest_runs|binary_matrix_rank|spectral|non_overlapping_template_matching|overlapping_template_matching|maurers_universal
coinflip local-run¶
Run randomness tests on DATA directly.
coinflip local-run [OPTIONS] DATA
Options
-
-d
,
--dtype
<dtype>
¶ Specify data type of the data.
Options: bool|byte|short|int|long|float|double
-
-t
,
--test
<test>
¶ Specify single test to run on data.
Options: monobit|frequency_within_block|runs|longest_runs|binary_matrix_rank|spectral|non_overlapping_template_matching|overlapping_template_matching|maurers_universal
Arguments
-
DATA
¶
Required argument