Show Menu
Cheatography

CTB Users Cheat Sheet (DRAFT) by

CTB Users Cheat Sheet

This is a draft cheat sheet. It is a work in progress and is not finished yet.

CTB Commands

gen_us­er_spec
Generate user spec file
gen_pr­oj_spec
Generate ctb workspace and project spec file
gen_fe­tch­_spec
Generate fetch group spec file
collec­t_f­etc­h_group
Collect the specified fetch group
test_m­ark­er_­script
Test the marker & adapter scripts on an example spf
gen_us­er_­token
Update user token and store it
Command Format: ctb <CO­MMA­ND>

Test Marker Scripts

--spf
VALUE
Full path to SPF file
--tuple
VALUE
Optional to search for Tuple instead of full path to spf file shown above
--marker
VALUE
E.g. array_­ato­m_m­arker, scan_g­t_d­e_m­arker, etc.
--adapter
VALUE
--rundir
PATH
Path to running directory
--project
STRING
--param
STRING
--hide­_py­tho­n_print
ctb test_m­ark­er_­script --help
 

Create Fetch Group

--project
STRING
Project name
--fetc­h_group
STRING
Fetch group name
--coll­ect­_te­mplate
[PLIST­|TI­D|T­UPL­E|ALL]
--cont­ent­_te­mplate
[ARRAY­_PB­IST­|AR­RAY­_MB­IST­|AR­RAY­_GT­|AR­RAY­_AT­OM|­FUN­C|S­CAN_GT]
--rundir
PATH
Path to running directory
ctb gen_fe­tch­_spec --help

Collect Fetch Groups

--fetc­h_group
STRING
Fetch group name (short: -f)
--grou­p_size
INTEGER
Group size (default: 50)
--no_d­ist­ributed
 
Disable NB distri­bution for Fetch & Mark (optional flag)
--project
STRING
Project name (short: -p), e.g. rpl, mtl, snr, etc.
--conv­ert­_local
 
(optional flag)
--sample
INTEGER
Number of samples, e.g. 2, 50, ...
--seed
INTEGER
Seed number (optional flag - default: RANDOM)
--no-cache
 
(optional flag)
--exte­rna­l_n­ame_dis
--session
STRING
ctb collec­t_f­etc­h_group --help