Command line interface
panqec
panqec - biased noise in 3D simulations.
See panqec COMMAND –help for command-specific help.
panqec [OPTIONS] COMMAND [ARGS]...
Options
- --version
Show the version and exit.
analyze
Analyze the data at given paths.
panqec analyze [OPTIONS] [PATHS]...
Options
- -o, --overrides <overrides>
Overrides specification .json file.
- -p, --plot_dir <plot_dir>
Directory to save plots in.
Arguments
- PATHS
Optional argument(s)
check-progress
Check usage of resources.
panqec check-progress [OPTIONS] LOG_DIR
Options
- -a, --show-all
Show progress on all the cores individually
Arguments
- LOG_DIR
Required argument
check-usage
Check usage of resources.
panqec check-usage [OPTIONS] DATA_DIRS...
Arguments
- DATA_DIRS
Required argument(s)
generate-cluster-script
Generate a generic cluster script from a given header file
panqec generate-cluster-script [OPTIONS] HEADER_FILE
Options
- -o, --output-file <output_file>
Required
- -d, --data-dir <data_dir>
Required
- --cluster <cluster>
Required
- Options:
sge | slurm | pbs
- -n, --n-nodes <n_nodes>
Required
- -w, --wall-time <wall_time>
Required
- -m, --memory <memory>
Required
- -t, --trials <trials>
Required
- -c, --n-cores <n_cores>
- -p, --partition <partition>
- Default:
pml
- -q, --qos <qos>
- Default:
dpart
- --working-dir <working_dir>
- Default:
.
- --delete-existing
- Default:
False
Arguments
- HEADER_FILE
Required argument
generate-input
Generate the json files of every experiment.
panqec generate-input [OPTIONS]
Options
- -d, --data_dir <data_dir>
Required Directory to save input .json files, as`[data_dir]/inputs/input_bias_[eta].json`
- --decoder_class <decoder_class>
Decoder class name. Use panqec ls decoders to find the list of all decoders.
- Default:
BeliefPropagationOSDDecoder- Options:
MatchingDecoder | SweepMatchDecoder | RotatedSweepMatchDecoder | BeliefPropagationOSDDecoder | MemoryBeliefPropagationDecoder | XCubeMatchingDecoder
- -s, --sizes <sizes>
List of sizes, separated by a comma, where each sizehas the form [Lx]x[Ly]x[Lz]
- Default:
3x3,5x5,7x7
- --bias <bias>
Pauli noise bias
- Default:
Z- Options:
X | Y | Z
- --eta <eta>
Bias ratio
- Default:
0.5
- --prob <prob>
min:max:step or single value or list of values
- Default:
0:0.6:0.005
- --code_class <code_class>
Code class name, e.g. Toric3DCode. Use panqec ls codes to find the list of all codes
- --noise_class <noise_class>
Error model class name, e.g. PauliErrorModel. Use panqec ls error_models to find the list of all error models
- Default:
PauliErrorModel
- --deformation_name <deformation_name>
Name of the Clifford deformation to use in our noise, e.g. XZZX
- -m, --method <method>
Simulation method, between “direct” (simple Monte-Carlo simulation)and “splitting” (Metropolis-Hastings for low error rates)
- Default:
direct- Options:
direct | splitting
- -l, --label <label>
Label for the inputs
ls
List available codes, error models and decoders.
panqec ls [OPTIONS] [[codes|error_models|decoders]]
Arguments
- MODEL_TYPE
Optional argument
merge-results
Merge result directories that had been split into outdir.
panqec merge-results [OPTIONS] RESULT_FILES...
Options
- -o, --output_file <output_file>
- Default:
merged-results.json.gz
Arguments
- RESULT_FILES
Required argument(s)
monitor-usage
Continously monitor CPU usage by logging to file at intervals.
Parameters
- log_filestr
Path to log file where messages are saved.
- intervalint
Interval at which to check usage, in seconds.
panqec monitor-usage [OPTIONS] LOG_FILE
Options
- -i, --interval <interval>
- Default:
10
Arguments
- LOG_FILE
Required argument
run
Run a single job or run many jobs from input file.
panqec run [OPTIONS]
Options
- -i, --input_file <input_file>
- -o, --output_file <output_file>
- -t, --trials <trials>
- Default:
100
run-parallel
Run panqec jobs in parallel
panqec run-parallel [OPTIONS]
Options
- -d, --data_dir <data_dir>
- -t, --trials <trials>
- Default:
1000
- -n, --n_nodes <n_nodes>
- Default:
1
- -j, --job_idx <job_idx>
- Default:
1
- -c, --n_cores <n_cores>
- --delete-existing
Delete existing results folder in the data directory
- Default:
False
slurm
Routines for generating and running slurm scripts.
panqec slurm [OPTIONS] COMMAND [ARGS]...
clear
Clear generated files.
panqec slurm clear [OPTIONS] {all|out|sbatch}
Arguments
- FOLDER
Required argument
count
Count number of input parameters contained.
panqec slurm count [OPTIONS] NAME
Arguments
- NAME
Required argument
status
Show the status of running jobs.
panqec slurm status [OPTIONS]
start-gui
panqec start-gui [OPTIONS]
Options
- -p, --port <port>