CLI Reference¶
The CITAM CLI
usage: citam [-h] <command> ...
Positional Arguments¶
- <command>
Possible choices: engine, config, dash
Sub-commands:¶
engine¶
Interact with the CITAM simulation engine
citam engine [-h] [-v] [--log-file LOG_FILE] <engine_command> ...
Positional Arguments¶
- <engine_command>
Possible choices: ingest, update-floorplan, list, export-floorplan, export-navnet, export-potential-oneways, build-navnet, run
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
Sub-commands:¶
ingest¶
Ingest raw floor plans and metadata files
citam engine ingest [-h] [-v] [--log-file LOG_FILE] [-c CSV] -s SVG
[--output_dir OUTPUT_DIR] [-b BUILDINGS [BUILDINGS ...]]
facility floor
Positional Arguments¶
- facility
Facility name
- floor
Floor name
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
- -c, --csv
CSV file with metadata for each space found in map file
- -s, --svg
Map file to ingest in SVG format.
- --output_dir
Directory to save ingestion files
- -b, --buildings
Buildings to process. Default to ‘all’.
update-floorplan¶
Update the floorplan data for a given simulation
citam engine update-floorplan [-h] [-v] [--log-file LOG_FILE] -s SVG
facility floor
Positional Arguments¶
- facility
Facility name
- floor
Facility name
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
- -s, --svg
Raw map SVG file
list¶
List all the floorplans already ingested.
citam engine list [-h] [-v] [--log-file LOG_FILE]
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
export-floorplan¶
Export a floorplan to an SVG file
citam engine export-floorplan [-h] [-v] [--log-file LOG_FILE] -o OUTPUTFILE
facility floor
Positional Arguments¶
- facility
Facility name
- floor
Floor name
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
- -o, --outputfile
Path to SVG file
export-potential-oneways¶
Export potential one-way ailes to an SVG file
citam engine export-potential-oneways [-h] [-v] [--log-file LOG_FILE] -o
OUTPUTFILE
facility floor
Positional Arguments¶
- facility
Facility name
- floor
Facility name
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
- -o, --outputfile
Path to SVG file
run¶
Run a simulation for a facility
citam engine run [-h] [-v] [--log-file LOG_FILE] input_file
Positional Arguments¶
- input_file
full path of file with simulation inputs
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
config¶
Interact with the CITAM global configuration
citam config [-h] [-v] [--log-file LOG_FILE] get
Positional Arguments¶
- get
Print the current CITAM configuration
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
dash¶
Start the CITAM dashboard
citam dash [-h] [-v] [--log-file LOG_FILE] [-p PORT] [--host HOST]
[-r RESULTS]
Named Arguments¶
- -v, --verbose
can be supplied multiple times to increase verbosity
Default: 0
- --log-file
log file location
- -p, --port
The port to use for the dashboard
Default: 8000
- --host
The host to serve the dashboard from
Default: “127.0.0.1”
- -r, --results
The directory to look for results in