Skip to content
Epistemix
today
Initializing search
Epistemix
Welcome
FRED Modeling Language
FRED Modeling Language
Background
Background
Introduction
What is Agent-Based Modeling?
What is FRED?
FRED 13.0 reference
FRED 13.0 reference
Changelog
Output Directory Structure
Symbols
Symbols
&& (ampersand)
# (pound)
|| (vertical bar)
a
a
abort
abs
acos
acosh
add
add_edge
add_site
add_to_schedule
adjust_contacts
african_american (constant)
age
agent_exists
age_in_days
age_in_years
agent
alaska_native (constant)
american_indian (constant)
and
Apr (constant)
arg_max
arg_min
arg_sort
asian (constant)
asin
asinh
ask
assign_agent_to_network
assign_agent_to_place
atan
atan2
atanh
attend
Aug (constant)
b
b
bernoulli
beta
binomial
birth_year
boarder (constant)
c
c
cauchy
ceil
chi_squared
child (constant)
clear
clear_schedule
clear_transmissible_agents
close
condition
contact_prob
contact_rate
cos
cosh
current_count
current_place
current_state
d
d
daily_count
date
datetime_add
day_of_month
day_of_week
day_of_year
days
Dec (constant)
default
delete_edge
dirichlet
dist
distance
div
e
e
edge
edge_count
edge_neighborhood
edges
enable_transmission_bias
end_date
epi_week
epi_year
eq
erase
Everyday (constant)
exit
exp
exponential
exposed_state
extreme_value
f
f
false (constant)
Feb (constant)
female (constant)
filter_by_index
filter_values
find_index
fisher_f
floor
for
foster_child (constant)
Fri (constant)
g
g
gamma
geometric
get_contact_rate
get_container
get_day_from_timestamp
get_group_agent
get_group_agents
get_hour_from_timestamp
get_keys
get_month_from_timestamp
get_number_of_transmissibles
get_population
get_role
get_same_age_bias
get_size
get_state
get_transmissibility
get_transmissible_list
get_values
get_weight
get_year_from_timestamp
getx
gety
gompertz
grandchild (constant)
group_id
group_start_state
gt
gte
h
h
has_group_agent
has_edge_from
hawaiian_native (constant)
hour
householder (constant)
housemate (constant)
i
i
id
if
import_exposures
in_law (constant)
indegree
index_values
inlinks
institutionalized_group_quarters_pop (constant)
int
intersection
is_at
is_date_in_range
is_directed
is_group_agent
is_group_open
is_in_list
is_in_range
is_key
is_member
is_meta_agent
is_open
is_skipping
is_temporarily_closed
j
j
Jan (constant)
join
Jun (constant)
Jul (constant)
l
l
last
latitude
length
list (action)
list (type)
list_table
locations
log
lognormal
longitude
lookup
lookup_list
lt
lte
m
m
male (constant)
Mar (constant)
max
max_loops
max_size
May (constant)
mean
mean_outdegree
mean_indegree
members
meta_start_state
min
Mon (constant)
month
mod
move
move_to
move_to_location
mult
multiple_race (constant)
n
n
negative_binomial
neq
network
next_if
next_with_prob
noninstitutionalized_group_quarters_pop (constant)
normal
not
Nov (constant)
now
nprob
numeric
o
o
Oct (constant)
open_csv
or
other_non_relative (constant)
other_race (constant)
other_relative (constant)
outdegree
outlinks
output (block)
output (property)
output_interval
p
p
parent (constant)
partial_sums
partner (constant)
percentile
place
poisson
pop
pow
preferential_attachment_network
prev_state
print
print_csv
print_file
prod
push
q
q
quit
r
r
randomize_network
range
range_list
read
read_agent_file
read_container_file
read_group_file
read_list_table
read_place_file
read_schedule_file
read_table
remove_from_schedule
reopen
reset_schedule
round
s
s
same_age_bias
sample_with_replacement
sample_without_replacement
Sat (constant)
select
send
Sep (constant)
set
set_age
set_default_value
set_difference
set_output_interval
set_state
set_sus
set_trans
set_weight
shared
shortest_path
shuffle
sibling (constant)
sim_day
sim_step
simulation
sin
sinh
site
sites
size
skip
sort
source
spawn_agent
spouse (constant)
sqrt
start_date
start_state
state
steps_between
student_t
sub
sum
Sun (constant)
sus_list
t
t
table
tan
tanh
tell
Thu (constant)
today
total_count
transmission_mode
transmission_network_name
transmissions
transmit
tribal (constant)
true (constant)
Tue (constant)
u
u
uniform
union
unique
unknown_race (constant)
until
v
v
variables
w
w
wait
wait_if
was_exposed_externally
was_exposed_in
Wed (constant)
Weekdays (constant)
Weekends (constant)
weibull
weight_neighborhood
while
white (constant)
y
y
year
FRED 12.1 reference
FRED 12.1 reference
Changelog
Symbols
Symbols
& (ampersand)
# (pound)
_ (underscore)
| (vertical bar)
A
A
abort
abs
acos
acosh
add
add_edge
add_site
add_to_schedule
adjust_contacts
african_american (constant)
age
agent_exists
age_in_days
age_in_years
agent
alaska_native (constant)
american_indian (constant)
and
apply
Apr (constant)
arg_max
arg_min
arg_sort
asian (constant)
asin
asinh
ask
assign_agent_to_network
assign_agent_to_place
atan
atan2
atanh
attend
Aug (constant)
B
B
bernoulli
beta
binomial
birth_year
boarder (constant)
C
C
cauchy
ceil
chi_squared
child (constant)
clear
clear_schedule
clear_transmissible_agents
close
comment
condition
contact_prob
contact_rate
cos
cosh
current_count
current_place
current_state
D
D
daily_count
date
datetime_add
day_of_month
day_of_week
day_of_year
days
Dec (constant)
default
default_value
delete_edge
dirichlet
dist
distance
div
E
E
edge
edge_count
edge_neighborhood
edges
enable_transmission_bias
end_date
epi_week
epi_year
eq
erase
Everyday (constant)
exit
exp
exponential
exposed_state
extreme_value
F
F
false (constant)
Feb (constant)
female (constant)
filter_agents
filter_by_index
filter_values
find_index
fisher_f
floor
for
foster_child (constant)
Fri (constant)
G
G
gamma
geometric
get_contact_rate
get_container
get_day_from_timestamp
get_group_agent
get_group_agents
get_hour_from_timestamp
get_keys
get_month_from_timestamp
get_number_of_transmissibles
get_population
get_role
get_same_age_bias
get_size
get_transmissibility
get_transmissible_list
get_values
get_weight
get_year_from_timestamp
getx
gety
gompertz
grandchild (constant)
group_id
group_start_state
gt
gte
H
H
has_group_agent
has_edge_from
hawaiian_native (constant)
hour
householder (constant)
housemate (constant)
I
I
id
if
import_exposures
in_law (constant)
include
indegree
index_agents
index_values
inlinks
institutionalized_group_quarters_pop (constant)
int
intersection
is_at
is_date_in_range
is_directed
is_group_agent
is_group_open
is_in_list
is_in_range
is_key
is_member
is_meta_agent
is_open
is_skipping
is_temporarily_closed
J
J
Jan (constant)
join
Jun (constant)
Jul (constant)
L
L
last
latitude
length
list (action)
list (type)
list_table
locations
log
lognormal
longitude
lookup
lookup_list
lt
lte
M
M
male (constant)
Mar (constant)
max
max_loops
max_size
May (constant)
mean
mean_outdegree
mean_indegree
members
meta_start_state
min
Mon (constant)
month
mod
move
move_to
move_to_location
mult
multiple_race (constant)
N
N
negative_binomial
neq
network
next
noninstitutionalized_group_quarters_pop (constant)
normal
not
Nov (constant)
now
nprob
numeric
O
O
Oct (constant)
open_csv
or
other_non_relative (constant)
other_race (constant)
other_relative (constant)
outdegree
outlinks
output (block)
output (property)
output_interval
P
P
parent (constant)
partial_sums
partner (constant)
percentile
place
poisson
pop
pow
preferential_attachment_network
prev_state
print
print_csv
print_file
prod
push
Q
Q
quit
R
R
randomize_network
range
range_list
read
read_agent_file
read_container_file
read_group_file
read_list_table
read_place_file
read_schedule_file
read_table
remove_from_schedule
reopen
reset_schedule
round
S
S
same_age_bias
sample_with_replacement
sample_without_replacement
Sat (constant)
select
select_index
send
Sep (constant)
set
set_age
set_difference
set_state
set_sus
set_trans
set_weight
shared
shortest_path
shuffle
sibling (constant)
sim_day
sim_step
simulation
sin
sinh
site
sites
size
skip
sort
source
spawn_agent
spouse (constant)
sqrt
start_date
start_state
state
steps_between
student_t
sub
sum
Sun (constant)
sus_list
T
T
table
tan
tanh
tell
Thu (constant)
today
total_count
transmission_mode
transmission_network_name
transmissions
transmit
tribal (constant)
true (constant)
Tue (constant)
U
U
uniform
union
unique
unknown_race (constant)
until
V
V
variables
W
W
wait
was_exposed_externally
was_exposed_in
Wed (constant)
Weekdays (constant)
Weekends (constant)
weibull
weight_neighborhood
while
white (constant)
Y
Y
year
FRED 12.0 reference
FRED 12.0 reference
Symbols
Symbols
& (ampersand)
# (pound)
_ (underscore)
| (vertical bar)
A
A
abort
abs
acos
acosh
add
add_edge
add_site
add_to_schedule
adjust_contacts
african_american (constant)
age
agent_exists
age_in_days
age_in_years
agent
alaska_native (constant)
american_indian (constant)
and
apply
Apr (constant)
arg_max
arg_min
arg_sort
asian (constant)
asin
asinh
ask
assign_agent_to_network
assign_agent_to_place
atan
atan2
atanh
attend
Aug (constant)
B
B
bernoulli
beta
binomial
birth_year
boarder (constant)
C
C
cauchy
ceil
chi_squared
child (constant)
clear
clear_schedule
clear_transmissible_agents
close
comment
condition
contact_prob
contact_rate
cos
cosh
current_count
current_place
current_state
D
D
daily_count
date
datetime_add
day_of_month
day_of_week
day_of_year
days
Dec (constant)
default
default_value
delete_edge
dirichlet
dist
distance
div
E
E
edge
edge_count
edge_neighborhood
edges
enable_transmission_bias
end_date
epi_week
epi_year
eq
erase
Everyday (constant)
exit
exp
exponential
exposed_state
extreme_value
F
F
false (constant)
Feb (constant)
female (constant)
filter_agents
filter_by_index
filter_values
find_index
fisher_f
floor
foster_child (constant)
Fri (constant)
G
G
gamma
geometric
get_contact_rate
get_container
get_day_from_timestamp
get_group_agent
get_group_agents
get_hour_from_timestamp
get_keys
get_month_from_timestamp
get_number_of_transmissibles
get_population
get_role
get_same_age_bias
get_size
get_transmissibility
get_transmissible_list
get_values
get_weight
get_year_from_timestamp
getx
gety
gompertz
grandchild (constant)
group_id
group_start_state
gt
gte
H
H
has_group_agent
has_edge_from
hawaiian_native (constant)
hour
householder (constant)
housemate (constant)
I
I
id
if
import_exposures
in_law (constant)
include
indegree
index_agents
index_values
inlinks
institutionalized_group_quarters_pop (constant)
int
intersection
is_at
is_date_in_range
is_directed
is_group_agent
is_group_open
is_in_list
is_in_range
is_key
is_member
is_meta_agent
is_open
is_skipping
is_temporarily_closed
J
J
Jan (constant)
join
Jun (constant)
Jul (constant)
L
L
last
latitude
length
list (action)
list (type)
list_table
locations
log
lognormal
longitude
lookup
lookup_list
lt
lte
M
M
male (constant)
Mar (constant)
max
max_loops
max_size
May (constant)
mean
mean_outdegree
mean_indegree
members
meta_start_state
min
Mon (constant)
month
mod
move
move_to
move_to_location
mult
multiple_race (constant)
N
N
negative_binomial
neq
network
next
noninstitutionalized_group_quarters_pop (constant)
normal
not
Nov (constant)
now
nprob
numeric
O
O
Oct (constant)
open_csv
or
other_non_relative (constant)
other_race (constant)
other_relative (constant)
outdegree
outlinks
output
output_interval
P
P
parent (constant)
partial_sums
partner (constant)
percentile
place
poisson
pop
pow
preferential_attachment_network
prev_state
print
print_csv
print_file
prod
push
Q
Q
quit
R
R
randomize_network
range
range_list
read
read_agent_file
read_container_file
read_group_file
read_list_table
read_place_file
read_schedule_file
read_table
remove_from_schedule
reopen
reset_schedule
round
S
S
same_age_bias
sample_with_replacement
sample_without_replacement
Sat (constant)
select
select_index
send
Sep (constant)
set
set_age
set_difference
set_state
set_sus
set_trans
set_weight
shared
shortest_path
shuffle
sibling (constant)
sim_day
sim_step
simulation
sin
sinh
site
sites
size
skip
sort
source
spawn_agent
spouse (constant)
sqrt
start_date
start_state
state
steps_between
student_t
sub
sum
Sun (constant)
sus_list
T
T
table
tan
tanh
tell
Thu (constant)
today
total_count
transmission_mode
transmission_network_name
transmissions
transmit
tribal (constant)
true (constant)
Tue (constant)
U
U
uniform
union
unique
unknown_race (constant)
until
V
V
variables
W
W
wait
was_exposed_externally
was_exposed_in
Wed (constant)
Weekdays (constant)
Weekends (constant)
weibull
weight_neighborhood
white (constant)
Y
Y
year
FRED 11.1 Reference
FRED 11.1 Reference
Symbols
Symbols
& (ampersand)
# (pound)
_ (underscore)
| (vertical bar)
A
A
abort
abs
acos
acosh
add
add_edge
add_site
add_to_schedule
adjust_contacts
african_american (constant)
age
agent_exists
age_in_days
age_in_years
agent
alaska_native (constant)
american_indian (constant)
and
apply
Apr (constant)
arg_max
arg_min
arg_sort
asian (constant)
asin
asinh
ask
assign_agent_to_network
atan
atan2
atanh
attend
Aug (constant)
B
B
bernoulli
binomial
birth_year
boarder (constant)
C
C
cauchy
ceil
chi_squared
child (constant)
clear
clear_schedule
clear_transmissible_agents
close
comment
condition
contact_prob
contact_rate
cos
cosh
current_count
current_place
current_state
D
D
daily_count
date
datetime_add
day_of_month
day_of_week
day_of_year
days
Dec (constant)
default
default_value
delete_edge
dist
distance
div
E
E
edge
edge_count
edge_neighborhood
edges
elevation
enable_transmission_bias
end_date
epi_week
epi_year
eq
erase
Everyday (constant)
exit
exp
exponential
exposed_state
extreme_value
F
F
false (constant)
Feb (constant)
female (constant)
filter_agents
filter_by_index
filter_values
find_index
fisher_f
floor
foster_child (constant)
Fri (constant)
G
G
gamma
geometric
get_contact_rate
get_container
get_day_from_timestamp
get_group_agent
get_group_agents
get_hour_from_timestamp
get_keys
get_month_from_timestamp
get_number_of_transmissibles
get_population
get_role
get_same_age_bias
get_size
get_transmissibility
get_transmissible_list
get_values
get_weight
get_year_from_timestamp
getx
gety
gompertz
grandchild (constant)
group_id
group_start_state
gt
gte
H
H
has_group_agent
has_edge_from
hawaiian_native (constant)
hour
householder (constant)
housemate (constant)
I
I
id
if
import_exposures
in_law (constant)
include
indegree
index_agents
index_values
inlinks
institutionalized_group_quarters_pop (constant)
int
intersection
is_at
is_date_in_range
is_directed
is_group_agent
is_group_open
is_in_list
is_in_range
is_key
is_member
is_meta_agent
is_open
is_skipping
is_temporarily_closed
J
J
Jan (constant)
join
Jun (constant)
Jul (constant)
L
L
last
latitude
length
list (action)
list (type)
list_table
locations
log
lognormal
longitude
lookup
lookup_list
lt
lte
M
M
male (constant)
Mar (constant)
max
max_loops
max_size
May (constant)
mean
mean_outdegree
mean_indegree
members
meta_start_state
min
Mon (constant)
month
mod
move
move_to
move_to_location
mult
multiple_race (constant)
N
N
negative_binomial
neq
network
next
noninstitutionalized_group_quarters_pop (constant)
normal
not
Nov (constant)
now
nprob
numeric
O
O
Oct (constant)
open_csv
or
other_non_relative (constant)
other_race (constant)
other_relative (constant)
outdegree
outlinks
output
output_interval
P
P
parent (constant)
partial_sums
partner (constant)
percentile
place
poisson
pop
pow
preferential_attachment_network
prev_state
print
print_csv
print_file
prod
push
Q
Q
quit
R
R
randomize_network
range
range_list
read
read_agent_file
read_container_file
read_group_file
read_list_table
read_place_file
read_schedule_file
read_table
remove_from_schedule
reopen
reset_schedule
round
S
S
same_age_bias
sample_with_replacement
sample_without_replacement
Sat (constant)
select
select_index
send
Sep (constant)
set
set_age
set_difference
set_state
set_sus
set_trans
set_weight
shared
shortest_path
shuffle
sibling (constant)
sim_day
sim_step
simulation
sin
sinh
site
sites
size
skip
sort
source
spawn_agent
spouse (constant)
sqrt
start_date
start_state
state
steps_between
student_t
sub
sum
Sun (constant)
sus_list
T
T
table
tan
tanh
tell
Thu (constant)
today
total_count
transmission_mode
transmission_network_name
transmissions
transmit
tribal (constant)
true (constant)
Tue (constant)
U
U
uniform
union
unique
unknown_race (constant)
until
V
V
variables
W
W
wait
was_exposed_externally
was_exposed_in
Wed (constant)
Weekdays (constant)
Weekends (constant)
weibull
weight_neighborhood
white (constant)
Y
Y
year
FRED 11.0 Reference
FRED 11.0 Reference
Symbols
Symbols
& (ampersand)
# (pound)
_ (underscore)
| (vertical bar)
A
A
abort
abs
acos
acosh
add
add_edge
add_site
add_to_schedule
adjust_contacts
african_american (constant)
age
age_in_days
age_in_years
agent
alaska_native (constant)
american_indian (constant)
and
apply
Apr (constant)
arg_max
arg_min
arg_sort
asian (constant)
asin
asinh
ask
assign_agent_to_network
atan
atan2
atanh
attend
Aug (constant)
B
B
bernoulli
binomial
birth_year
boarder (constant)
C
C
cauchy
ceil
chi_squared
child (constant)
clear
clear_schedule
clear_transmissible_agents
close
comment
condition
contact_prob
contact_rate
cos
cosh
current_count
current_place
current_state
D
D
daily_count
date
day_of_month
day_of_week
day_of_year
days
Dec (constant)
default
default_value
delete_edge
dist
distance
div
E
E
edge
edge_count
edge_neighborhood
edges
elevation
enable_transmission_bias
end_date
epi_week
epi_year
eq
erase
Everyday (constant)
exit
exp
exponential
exposed_state
extreme_value
F
F
false (constant)
Feb (constant)
female (constant)
filter_agents
filter_by_index
filter_values
find_index
fisher_f
floor
foster_child (constant)
Fri (constant)
G
G
gamma
geometric
get_contact_rate
get_container
get_day_from_timestamp
get_group_agent
get_group_agents
get_hour_from_timestamp
get_keys
get_month_from_timestamp
get_number_of_transmissibles
get_population
get_role
get_same_age_bias
get_size
get_transmissibility
get_transmissible_list
get_values
get_weight
get_year_from_timestamp
getx
gety
gompertz
grandchild (constant)
group_id
group_start_state
gt
gte
H
H
has_group_agent
has_edge_from
hawaiian_native (constant)
hour
householder (constant)
housemate (constant)
I
I
id
if
import_exposures
in_law (constant)
include
indegree
index_agents
index_values
inlinks
institutionalized_group_quarters_pop (constant)
int
intersection
is_at
is_date_in_range
is_directed
is_group_agent
is_group_open
is_in_list
is_in_range
is_key
is_member
is_meta_agent
is_open
is_skipping
is_temporarily_closed
J
J
Jan (constant)
join
Jun (constant)
Jul (constant)
L
L
last
latitude
length
list (action)
list (type)
list_table
locations
log
lognormal
longitude
lookup
lookup_list
lt
lte
M
M
male (constant)
Mar (constant)
max
max_loops
max_size
May (constant)
mean_outdegree
mean_indegree
members
meta_start_state
min
Mon (constant)
month
mod
move
move_to
move_to_location
mult
multiple_race (constant)
N
N
negative_binomial
neq
network
next
noninstitutionalized_group_quarters_pop (constant)
normal
not
Nov (constant)
now
nprob
numeric
O
O
Oct (constant)
open_csv
or
other_non_relative (constant)
other_race (constant)
other_relative (constant)
outdegree
outlinks
output
output_interval
P
P
parent (constant)
partial_sums
partner (constant)
percentile
place
poisson
pop
pow
preferential_attachment_network
prev_state
print
print_csv
print_file
prod
push
Q
Q
quit
R
R
randomize_network
range
range_list
read
read_agent_file
read_container_file
read_group_file
read_list_table
read_place_file
read_schedule_file
read_table
remove_from_schedule
reopen
reset_schedule
round
S
S
same_age_bias
sample_with_replacement
sample_without_replacement
Sat (constant)
select
select_index
send
Sep (constant)
set
set_age
set_difference
set_state
set_sus
set_trans
set_weight
shared
shortest_path
shuffle
sibling (constant)
sim_day
sim_step
simulation
sin
sinh
site
sites
size
skip
sort
source
spawn_agent
spouse (constant)
sqrt
start_date
start_state
state
steps_between
student_t
sub
sum
Sun (constant)
sus_list
T
T
table
tan
tanh
tell
Thu (constant)
today
today
Table of contents
Syntax
total_count
transmission_mode
transmission_network_name
transmissions
transmit
tribal (constant)
true (constant)
Tue (constant)
U
U
uniform
union
unique
unknown_race (constant)
until
V
V
variables
W
W
wait
was_exposed_externally
was_exposed_in
Wed (constant)
Weekdays (constant)
Weekends (constant)
weibull
weight_neighborhood
white (constant)
Y
Y
year
Platform
Platform
Overview
Getting Started
Next Steps
Quickstart Guide
Quickstart Guide
Overview
1. A Minimal FRED Model
2. Introduction to Conditions and States
3. Agents
4. Models With More Than One Condition
5. Places
6. Agent-Agent Interaction
7. Transmission
8. Agent-Place Interaction
9. Control Structures
10. Data Input and Output
Including External Data in a FRED model
Epx package v0.2.0
Epx package v1.1.0
What is agent-based modeling?
Community Library
Synthetic Population
Synthetic Population
What is a Synthetic Population?
Constructing a Synthetic Population
Using the Synthetic Population
Customizing a Synthetic Population
Table of contents
Syntax
today
¶
This action is the same as the
date
action.
Syntax
¶
today
()