PyRates Documentation
stable
Overview
General Information
Installation and Requirements
Example: Two rate-coupled leaky integrators
Mathematical Framework and Syntax
Model Definition via YAML Templates
Changelog
Use Examples
1. Model Definition/Implementation
2. Pre-Implemented Models
3. Model Analysis
API
1. PyRates.pyrates
2. PyRates.model_templates
3. PyRates.tests
PyRates Documentation
Docs
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
_
__call__() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
__getitem__() (pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.frontend.template.operator.OperatorTemplate method)
(pyrates.frontend.template.operator_graph.OperatorGraphTemplate method)
(pyrates.ir.abc.AbstractBaseIR method)
(pyrates.ir.circuit.NetworkGraph method)
__iter__() (pyrates.ir.node.NodeIR method)
(pyrates.ir.node.VectorizedNodeIR method)
(pyrates.ir.operator_graph.OperatorGraph method)
__len__() (pyrates.ir.node.VectorizedNodeIR method)
__repr__() (pyrates.frontend.template.abc.AbstractBaseTemplate method)
A
AbstractBaseIR (class in pyrates.ir.abc)
AbstractBaseTemplate (class in pyrates.frontend.template.abc)
adapt_circuit() (in module pyrates.utility)
,
[1]
add_code_line() (pyrates.backend.base.base_backend.CodeGen method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
add_edge() (pyrates.ir.circuit.NetworkGraph method)
add_edges_from_matrix() (pyrates.frontend.template.circuit.CircuitTemplate method)
add_import() (pyrates.backend.base.base_backend.BaseBackend method)
add_indent() (pyrates.backend.base.base_backend.CodeGen method)
add_linebreak() (pyrates.backend.base.base_backend.CodeGen method)
add_node_template() (pyrates.frontend.template.circuit.CircuitTemplate method)
add_op() (pyrates.backend.computegraph.ComputeGraph method)
(pyrates.ir.node.VectorizedNodeIR method)
add_op_edge() (pyrates.ir.node.VectorizedNodeIR method)
add_operator() (pyrates.ir.operator_graph.VectorizedOperatorGraph method)
add_parsed_variable() (pyrates.ir.operator.ProtectedVariableDict method)
add_to_dict() (in module pyrates.frontend.dict)
add_var() (pyrates.backend.computegraph.ComputeGraph method)
add_var_hist() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.julia.julia_backend.JuliaBackend method)
add_var_update() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.computegraph.ComputeGraph method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
(pyrates.backend.julia.julia_backend.JuliaBackend method)
(pyrates.backend.tensorflow.tensorflow_backend.TensorflowBackend method)
Algebra (class in pyrates.backend.parser)
append_values() (pyrates.ir.operator_graph.VectorizedOperatorGraph method)
apply() (pyrates.frontend.template.abc.AbstractBaseTemplate method)
(pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.frontend.template.operator.OperatorTemplate method)
(pyrates.frontend.template.operator_graph.OperatorGraphTemplate method)
B
BaseBackend (class in pyrates.backend.base.base_backend)
break_line() (pyrates.backend.fortran.fortran_backend.FortranBackend method)
C
cache (pyrates.frontend.template.operator.OperatorTemplate attribute)
cache_func() (in module pyrates.ir.node)
cg (pyrates.backend.parser.ExpressionParser attribute)
check_vname() (in module pyrates.frontend.template.operator)
CircuitIR (class in pyrates.ir.circuit)
circuits (pyrates.frontend.template.circuit.CircuitTemplate attribute)
CircuitTemplate (class in pyrates.frontend.template.circuit)
clear() (in module pyrates.utility)
,
[1]
(pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.base.base_backend.CodeGen method)
(pyrates.backend.computegraph.ComputeGraph method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
(pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.ir.circuit.CircuitIR method)
clear_cache() (in module pyrates.frontend.template)
clear_frontend_caches() (in module pyrates.utility)
,
[1]
clear_ir_caches() (in module pyrates.ir.node)
CodeGen (class in pyrates.backend.base.base_backend)
collect_edges() (pyrates.frontend.template.circuit.CircuitTemplate method)
compile() (pyrates.backend.computegraph.ComputeGraph method)
compute_graph (pyrates.frontend.template.circuit.CircuitTemplate property)
ComputeGraph (class in pyrates.backend.computegraph)
ComputeGraphBackProp (class in pyrates.backend.computegraph)
ComputeNode (class in pyrates.backend.computegraph)
ComputeOp (class in pyrates.backend.computegraph)
ComputeVar (class in pyrates.backend.computegraph)
create_directory() (in module pyrates.utility)
,
[1]
create_index_str() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
(pyrates.backend.julia.julia_backend.JuliaBackend method)
(pyrates.backend.tensorflow.tensorflow_backend.TensorflowBackend method)
create_input_node() (in module pyrates.frontend.template.circuit)
D
dict_from_yaml() (in module pyrates.frontend.fileio.yaml)
dtype (pyrates.backend.computegraph.ComputeNode attribute)
(pyrates.backend.computegraph.ComputeOp attribute)
(pyrates.backend.computegraph.ComputeVar attribute)
(pyrates.ir.operator.Variable attribute)
dump() (in module pyrates.frontend.fileio.pickle)
dump_to_yaml() (in module pyrates.frontend.fileio.yaml)
E
EdgeIR (class in pyrates.ir.edge)
edges (pyrates.frontend.template.circuit.CircuitTemplate attribute)
(pyrates.ir.circuit.CircuitIR property)
(pyrates.ir.circuit.NetworkGraph property)
EdgeTemplate (class in pyrates.frontend.template.edge)
equations (pyrates.ir.operator.OperatorIR property)
eval_graph() (pyrates.backend.computegraph.ComputeGraph method)
eval_node() (pyrates.backend.computegraph.ComputeGraph method)
eval_nodes() (pyrates.backend.computegraph.ComputeGraph method)
eval_subgraph() (pyrates.backend.computegraph.ComputeGraph method)
expr (pyrates.backend.computegraph.ComputeOp attribute)
expr_stack (pyrates.backend.parser.ExpressionParser attribute)
expr_str (pyrates.backend.parser.ExpressionParser attribute)
expr_to_str() (pyrates.backend.base.base_backend.BaseBackend static method)
(pyrates.backend.fortran.fortran_backend.FortranBackend static method)
(pyrates.backend.julia.julia_backend.JuliaBackend static method)
ExpressionParser (class in pyrates.backend.parser)
extend() (pyrates.ir.node.VectorizedNodeIR method)
extract_var() (in module pyrates.backend.parser)
F
finalize_idx_str() (pyrates.backend.base.base_backend.BaseBackend static method)
(pyrates.backend.tensorflow.tensorflow_backend.TensorflowBackend method)
FortranBackend (class in pyrates.backend.fortran.fortran_backend)
from_circuit() (in module pyrates.frontend.dict)
from_edge() (in module pyrates.frontend.dict)
from_file() (pyrates.ir.abc.AbstractBaseIR class method)
from_node() (in module pyrates.frontend.dict)
from_operator() (in module pyrates.frontend.dict)
from_yaml() (in module pyrates.frontend.template)
(pyrates.frontend.template.abc.AbstractBaseTemplate class method)
func (pyrates.backend.computegraph.ComputeOp attribute)
G
generate() (pyrates.backend.base.base_backend.CodeGen method)
generate_func() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
(pyrates.backend.julia.julia_backend.JuliaBackend method)
generate_func_head() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
generate_func_tail() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
(pyrates.backend.julia.julia_backend.JuliaBackend method)
get_data() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
get_edge() (pyrates.frontend.template.circuit.CircuitTemplate method)
get_edges() (pyrates.frontend.template.circuit.CircuitTemplate method)
get_fname() (pyrates.backend.base.base_backend.BaseBackend method)
get_frontend_varname() (pyrates.ir.circuit.CircuitIR method)
get_hist_func() (pyrates.backend.base.base_backend.BaseBackend static method)
(pyrates.backend.julia.julia_backend.JuliaBackend method)
get_inputs() (pyrates.ir.edge.EdgeIR method)
get_interp_def() (in module pyrates.backend.fortran.fortran_funcs)
get_node_template() (pyrates.frontend.template.circuit.CircuitTemplate method)
get_nodes() (pyrates.frontend.template.circuit.CircuitTemplate method)
get_op() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.computegraph.ComputeGraph method)
(pyrates.frontend.template.operator_graph.OperatorGraphTemplate method)
get_run_func() (pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.ir.circuit.CircuitIR method)
get_sigmoid_def() (in module pyrates.backend.fortran.fortran_funcs)
get_sign_def() (in module pyrates.backend.fortran.fortran_funcs)
get_unique_label() (in module pyrates.backend.parser)
get_var() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.computegraph.ComputeGraph method)
(pyrates.backend.julia.julia_backend.JuliaBackend method)
(pyrates.backend.tensorflow.tensorflow_backend.TensorflowBackend method)
(pyrates.backend.torch.torch_backend.TorchBackend method)
(pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.ir.circuit.CircuitIR method)
get_variable_positions() (pyrates.frontend.template.circuit.CircuitTemplate method)
getitem_from_iterator() (pyrates.ir.abc.AbstractBaseIR method)
(pyrates.ir.circuit.CircuitIR method)
(pyrates.ir.circuit.NetworkGraph method)
(pyrates.ir.node.NodeIR method)
(pyrates.ir.node.VectorizedNodeIR method)
(pyrates.ir.operator.OperatorIR method)
(pyrates.ir.operator_graph.OperatorGraph method)
(pyrates.ir.operator_graph.VectorizedOperatorGraph method)
graph (pyrates.ir.circuit.CircuitIR attribute)
grid_search() (in module pyrates.utility)
,
[1]
I
identity() (in module pyrates.backend.base.base_funcs)
index_1d() (in module pyrates.backend.base.base_funcs)
index_2d() (in module pyrates.backend.base.base_funcs)
index_axis() (in module pyrates.backend.base.base_funcs)
index_range() (in module pyrates.backend.base.base_funcs)
inputs (pyrates.ir.edge.EdgeIR property)
(pyrates.ir.operator.OperatorIR property)
integrate() (in module pyrates.utility)
,
[1]
Interactive2DParamPlot (class in pyrates.utility)
,
[1]
intermediate_representation (pyrates.frontend.template.circuit.CircuitTemplate property)
is_complex (pyrates.backend.computegraph.ComputeNode property)
is_constant (pyrates.backend.computegraph.ComputeNode property)
(pyrates.backend.computegraph.ComputeOp property)
(pyrates.backend.computegraph.ComputeVar property)
is_diff_eq() (in module pyrates.backend.parser)
is_float (pyrates.backend.computegraph.ComputeNode property)
is_integration_adaptive() (in module pyrates.frontend.template.circuit)
items() (pyrates.ir.operator.ProtectedVariableDict method)
J
JuliaBackend (class in pyrates.backend.julia.julia_backend)
K
keys() (pyrates.ir.operator.ProtectedVariableDict method)
L
label (pyrates.ir.abc.AbstractBaseIR attribute)
(pyrates.ir.circuit.CircuitIR attribute)
(pyrates.ir.circuit.NetworkGraph attribute)
length (pyrates.ir.edge.EdgeIR attribute)
(pyrates.ir.node.VectorizedNodeIR attribute)
lhs (pyrates.backend.parser.ExpressionParser attribute)
linearize_grid() (in module pyrates.utility)
,
[1]
linebreak_end (pyrates.backend.fortran.fortran_backend.FortranBackend attribute)
linebreak_start (pyrates.backend.fortran.fortran_backend.FortranBackend attribute)
load() (in module pyrates.frontend.fileio.pickle)
M
module
pyrates.backend
pyrates.backend.base
pyrates.backend.base.base_backend
pyrates.backend.base.base_funcs
pyrates.backend.computegraph
pyrates.backend.fortran
pyrates.backend.fortran.fortran_backend
pyrates.backend.fortran.fortran_funcs
pyrates.backend.julia
pyrates.backend.julia.julia_backend
pyrates.backend.julia.julia_funcs
pyrates.backend.parser
pyrates.backend.tensorflow
pyrates.backend.tensorflow.tensorflow_backend
pyrates.backend.tensorflow.tensorflow_funcs
pyrates.backend.torch
pyrates.backend.torch.torch_backend
pyrates.backend.torch.torch_funcs
pyrates.frontend
pyrates.frontend.dict
pyrates.frontend.file
pyrates.frontend.fileio
pyrates.frontend.fileio.pickle
pyrates.frontend.fileio.yaml
pyrates.frontend.template
pyrates.frontend.template.abc
pyrates.frontend.template.circuit
pyrates.frontend.template.edge
pyrates.frontend.template.node
pyrates.frontend.template.operator
pyrates.frontend.template.operator_graph
pyrates.ir
pyrates.ir.abc
pyrates.ir.circuit
pyrates.ir.edge
pyrates.ir.node
pyrates.ir.operator
pyrates.ir.operator_graph
pyrates.utility
,
[1]
tests.test_backend_parser
tests.test_backend_simulations
tests.test_implemented_models
N
n1 (pyrates.backend.fortran.fortran_backend.FortranBackend attribute)
n2 (pyrates.backend.fortran.fortran_backend.FortranBackend attribute)
n_inputs (pyrates.ir.edge.EdgeIR property)
name (pyrates.backend.computegraph.ComputeNode attribute)
(pyrates.backend.computegraph.ComputeOp attribute)
(pyrates.backend.computegraph.ComputeVar attribute)
network_to_computegraph() (pyrates.ir.circuit.CircuitIR method)
NetworkGraph (class in pyrates.ir.circuit)
nmrse() (in module tests.test_backend_simulations)
(in module tests.test_implemented_models)
NodeIR (class in pyrates.ir.node)
nodes (pyrates.frontend.template.circuit.CircuitTemplate attribute)
(pyrates.ir.circuit.CircuitIR property)
(pyrates.ir.circuit.NetworkGraph property)
NodeTemplate (class in pyrates.frontend.template.node)
O
op_graph (pyrates.ir.edge.EdgeIR attribute)
(pyrates.ir.node.NodeIR property)
(pyrates.ir.node.VectorizedNodeIR attribute)
OperatorGraph (class in pyrates.ir.operator_graph)
OperatorGraphTemplate (class in pyrates.frontend.template.operator_graph)
OperatorIR (class in pyrates.ir.operator)
operators (pyrates.ir.node.NodeIR property)
(pyrates.ir.node.VectorizedNodeIR property)
(pyrates.ir.operator_graph.VectorizedOperatorGraph property)
operators() (pyrates.ir.operator_graph.OperatorGraph method)
OperatorTemplate (class in pyrates.frontend.template.operator)
output (pyrates.ir.edge.EdgeIR property)
(pyrates.ir.operator.OperatorIR property)
P
parse_equations() (in module pyrates.backend.parser)
parse_expr() (pyrates.backend.parser.ExpressionParser method)
parse_func (pyrates.backend.parser.ExpressionParser attribute)
parse_path() (in module pyrates.frontend.file)
past() (in module pyrates.backend.base.base_funcs)
ProtectedVariableDict (class in pyrates.ir.operator)
pyrates.backend
module
pyrates.backend.base
module
pyrates.backend.base.base_backend
module
pyrates.backend.base.base_funcs
module
pyrates.backend.computegraph
module
pyrates.backend.fortran
module
pyrates.backend.fortran.fortran_backend
module
pyrates.backend.fortran.fortran_funcs
module
pyrates.backend.julia
module
pyrates.backend.julia.julia_backend
module
pyrates.backend.julia.julia_funcs
module
pyrates.backend.parser
module
pyrates.backend.tensorflow
module
pyrates.backend.tensorflow.tensorflow_backend
module
pyrates.backend.tensorflow.tensorflow_funcs
module
pyrates.backend.torch
module
pyrates.backend.torch.torch_backend
module
pyrates.backend.torch.torch_funcs
module
pyrates.frontend
module
pyrates.frontend.dict
module
pyrates.frontend.file
module
pyrates.frontend.fileio
module
pyrates.frontend.fileio.pickle
module
pyrates.frontend.fileio.yaml
module
pyrates.frontend.template
module
pyrates.frontend.template.abc
module
pyrates.frontend.template.circuit
module
pyrates.frontend.template.edge
module
pyrates.frontend.template.node
module
pyrates.frontend.template.operator
module
pyrates.frontend.template.operator_graph
module
pyrates.ir
module
pyrates.ir.abc
module
pyrates.ir.circuit
module
pyrates.ir.edge
module
pyrates.ir.node
module
pyrates.ir.operator
module
pyrates.ir.operator_graph
module
pyrates.utility
module
,
[1]
PyRatesException
PyRatesWarning
R
register_template_class() (in module pyrates.frontend.template)
register_vars() (pyrates.backend.base.base_backend.BaseBackend static method)
(pyrates.backend.fortran.fortran_backend.FortranBackend method)
remove_indent() (pyrates.backend.base.base_backend.CodeGen method)
remove_subgraph() (pyrates.backend.computegraph.ComputeGraph method)
replace() (in module pyrates.backend.parser)
replace_in_expr() (in module pyrates.backend.parser)
reshape() (pyrates.backend.computegraph.ComputeNode method)
rhs (pyrates.backend.parser.ExpressionParser attribute)
run() (pyrates.backend.base.base_backend.BaseBackend method)
(pyrates.backend.computegraph.ComputeGraph method)
(pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.ir.circuit.CircuitIR method)
S
save() (in module pyrates.frontend.fileio)
set_dtype() (pyrates.backend.computegraph.ComputeNode method)
set_map_title() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
set_map_xlabel() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
set_map_ylabel() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
set_num_axis_ticks() (in module pyrates.utility)
,
[1]
set_series_xlabel() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
set_series_ylabel() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
set_value() (pyrates.backend.computegraph.ComputeNode method)
setup_module() (in module tests.test_backend_parser)
(in module tests.test_backend_simulations)
(in module tests.test_implemented_models)
shape (pyrates.backend.computegraph.ComputeNode attribute)
(pyrates.backend.computegraph.ComputeOp attribute)
(pyrates.backend.computegraph.ComputeVar attribute)
(pyrates.ir.operator.Variable attribute)
sigmoid() (in module pyrates.backend.fortran.fortran_funcs)
(in module pyrates.backend.tensorflow.tensorflow_funcs)
(in module pyrates.backend.torch.torch_funcs)
sigmoid_func() (in module pyrates.backend.julia.julia_funcs)
split_equation() (in module pyrates.backend.parser)
squeeze() (pyrates.backend.computegraph.ComputeNode method)
state_vars (pyrates.backend.computegraph.ComputeGraph property)
symbol (pyrates.backend.computegraph.ComputeNode attribute)
(pyrates.backend.computegraph.ComputeOp attribute)
(pyrates.backend.computegraph.ComputeVar attribute)
T
target_ir (pyrates.frontend.template.abc.AbstractBaseTemplate attribute)
(pyrates.frontend.template.circuit.CircuitTemplate attribute)
(pyrates.frontend.template.operator.OperatorTemplate attribute)
target_ir() (pyrates.frontend.template.edge.EdgeTemplate static method)
(pyrates.frontend.template.node.NodeTemplate static method)
(pyrates.frontend.template.operator_graph.OperatorGraphTemplate static method)
template (pyrates.ir.abc.AbstractBaseIR property)
TensorflowBackend (class in pyrates.backend.tensorflow.tensorflow_backend)
test_1_1_expression_parser_init() (in module tests.test_backend_parser)
test_1_2_expression_parser_parsing_exceptions() (in module tests.test_backend_parser)
test_1_3_expression_parser_math_ops() (in module tests.test_backend_parser)
test_1_4_expression_parser_funcs() (in module tests.test_backend_parser)
test_1_5_expression_parser_indexing() (in module tests.test_backend_parser)
test_1_7_equation_parsing() (in module tests.test_backend_parser)
test_2_1_operator() (in module tests.test_backend_simulations)
test_2_2_node() (in module tests.test_backend_simulations)
test_2_3_edge() (in module tests.test_backend_simulations)
test_2_4_solver() (in module tests.test_backend_simulations)
test_2_5_inputs_outputs() (in module tests.test_backend_simulations)
test_2_6_vectorization() (in module tests.test_backend_simulations)
test_2_7_backends() (in module tests.test_backend_simulations)
test_3_1_jansenrit() (in module tests.test_implemented_models)
test_3_2_qif_theta() (in module tests.test_implemented_models)
test_3_3_wilson_cowan() (in module tests.test_implemented_models)
test_3_4_kuramoto() (in module tests.test_implemented_models)
tests.test_backend_parser
module
tests.test_backend_simulations
module
tests.test_implemented_models
module
to_dict() (pyrates.ir.operator.ProtectedVariableDict method)
to_file() (pyrates.backend.base.base_backend.BaseBackend static method)
(pyrates.ir.abc.AbstractBaseIR method)
to_func() (pyrates.backend.computegraph.ComputeGraph method)
to_yaml() (in module pyrates.frontend.template)
(pyrates.frontend.template.abc.AbstractBaseTemplate method)
(pyrates.frontend.template.circuit.CircuitTemplate method)
TorchBackend (class in pyrates.backend.torch.torch_backend)
U
update_dict() (in module pyrates.frontend.template.circuit)
update_edges() (in module pyrates.frontend.template.circuit)
update_lineplot() (pyrates.utility.Interactive2DParamPlot method)
,
[1]
update_template() (pyrates.frontend.template.abc.AbstractBaseTemplate method)
(pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.frontend.template.operator.OperatorTemplate method)
(pyrates.frontend.template.operator_graph.OperatorGraphTemplate method)
update_var() (pyrates.frontend.template.circuit.CircuitTemplate method)
(pyrates.frontend.template.operator_graph.OperatorGraphTemplate method)
V
value (pyrates.backend.computegraph.ComputeNode property)
values (pyrates.ir.node.NodeIR attribute)
values() (pyrates.ir.operator.ProtectedVariableDict method)
var_in_expression() (in module pyrates.backend.parser)
var_lengths (pyrates.ir.operator_graph.VectorizedOperatorGraph property)
Variable (class in pyrates.ir.operator)
variables (pyrates.ir.operator.OperatorIR property)
vars (pyrates.backend.parser.ExpressionParser attribute)
VectorizedNodeIR (class in pyrates.ir.node)
VectorizedOperatorGraph (class in pyrates.ir.operator_graph)
vtype (pyrates.backend.computegraph.ComputeVar attribute)
(pyrates.ir.operator.Variable attribute)
Read the Docs
v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.