fred_map

This reference page is not yet available.

Synopsis

usage: fred_map [ options ], where options include [default values]
    --api_key <key>: if set, use this api_key to obtain Google maps ["none"]
    --caption_colors 'c1 c2 c3': colors for left, center and right captions
    --census_tracts 0/1: plot census tracts [0]
    --center_caption '<text>' : center caption ['']
    --colors 'c1 c2 c3 ...': colors for each variable []
    --country <name> : plot the named country [usa]
    --display <0/1> : if set, play the movie after it is made [0]
    --help: print this help message
    --key <id> : plot the job with given id [none - must be specified]
    --left_caption '<text>' : left caption ['']
    --lightness <n> : set lightness of background map [0]
    --lw <n> : use linewidth n to outline counties [2]
    --output <str> : movie file name with extension .mp4 added [job_name]
    --periods 'n1 n2 ...' : plot accumulated locations of var over given number of days [ '1 1 ...' ]
                            period=0 means map all locs since start of the run
    --play <0/1> : if set, play the movie after it is made [0]
    --ps 'n1 n2 n3' : plot dots using point sizes [ '0.002 0.002 ...' ]
    --pt 'n1 n2 n3' : plot dots using point type [ '99 99 ...' ]
    --right_caption '<text>' : right caption ['']
    --run <n> : plot results of run n [1]
    --shapefile <0/1> : if set, draw the shapefile for each fips code
    --subtitle <str> : subtitle for each map [" "]
    --subsubtitle <str> : subsubtitle for each map [" "]
    --title <str> : title for each map ["FRED Simulation"]
    --vars <v1,v2,...,vn> : variable to plot [none]
    -x <xmin> : min longitude [none]
    -X <xmax> : max longitude [none]
    -y <ymin> : min latitude [none]
    -Y <xmax> : max latitude [none]

Description

This will be replaced with a command description

Options

-h

Print the usage message for this command.

-a

Option description, these will be in the same order as the usage message

-b

Option description, ending in a period.

Returns

This will describe the typical output or return value of the item, where applicable.

Examples

This will provide one or more examples for the command.

# some code

Environment

This will describe any key environment variables or other environmental settings that impact this item. If none, this will be deleted.

Errors

This will list the errors that may occur with this item. An exhaustive list is not required.

Notes

Any other notes related to this item, or remove this section. This might include:

  • The release this item was introduced. Use sentence “This <type> was introduced in release X.X”

  • Implementation notes such as complexity or resource utilization (such as memory).

  • Other important information as appropriate.

See Also

To be replaced with appropriate references, use the ref directive, as in

:ref:`fred_compile`

This produces the link fred_job, or just prints the name if the reference does not exist.