ptyrad.cli.commands

Commands for the CLI, including initializing a project folder, getting params and examples files, running PtyRAD, etc.

Functions

check_gpu(args)	Check GPU availability
export_meas(args)	Export initialized measurements file to disk
get_examples(args)	Copy examples params files
get_params(args)	Copy all parameter files (templates + examples)
get_templates(args)	Copy clean templates params files
get_walkthrough(args)	Copy walkthrough params files
gui(args)	Launch GUI (not implemented yet)
init_project(args)	Initialize a new PtyRAD starter project
print_info(args)	Print system info
run(args)	Run PtyRAD reconstruction
validate_params(args)	Validate parameter file

ptyrad.cli.commands.init_project(args)

Initialize a new PtyRAD starter project

ptyrad.cli.commands.get_params(args)

Copy all parameter files (templates + examples)

ptyrad.cli.commands.get_templates(args)

Copy clean templates params files

ptyrad.cli.commands.get_examples(args)

Copy examples params files

ptyrad.cli.commands.get_walkthrough(args)

Copy walkthrough params files

ptyrad.cli.commands.run(args)

Run PtyRAD reconstruction

ptyrad.cli.commands.check_gpu(args)

Check GPU availability

ptyrad.cli.commands.print_info(args)

Print system info

ptyrad.cli.commands.export_meas(args)

Export initialized measurements file to disk

ptyrad.cli.commands.validate_params(args)

Validate parameter file

ptyrad.cli.commands.gui(args)

Launch GUI (not implemented yet)