1.3. PyRates.pyrates.frontend

1.3.1. pyrates.frontend module

• 1.3.1.1. PyRates.pyrates.frontend.template
  • 1.3.1.1.1. pyrates.frontend.template module
    • clear_cache()
    • from_yaml()
    • register_template_class()
    • to_yaml()
  • 1.3.1.1.2. pyrates.frontend.template.abc module
    • AbstractBaseTemplate
      • AbstractBaseTemplate.__repr__()
      • AbstractBaseTemplate.apply()
      • AbstractBaseTemplate.from_yaml()
      • AbstractBaseTemplate.target_ir
      • AbstractBaseTemplate.to_yaml()
      • AbstractBaseTemplate.update_template()
  • 1.3.1.1.3. pyrates.frontend.template.circuit module
    • CircuitTemplate
      • CircuitTemplate.nodes
      • CircuitTemplate.circuits
      • CircuitTemplate.edges
      • CircuitTemplate.__getitem__()
      • CircuitTemplate.add_edges_from_matrix()
      • CircuitTemplate.add_node_template()
      • CircuitTemplate.apply()
      • CircuitTemplate.clear()
      • CircuitTemplate.collect_edges()
      • CircuitTemplate.compute_graph
      • CircuitTemplate.get_edge()
      • CircuitTemplate.get_edges()
      • CircuitTemplate.get_jacobian_func()
      • CircuitTemplate.get_node_template()
      • CircuitTemplate.get_nodes()
      • CircuitTemplate.get_run_func()
      • CircuitTemplate.get_var()
      • CircuitTemplate.get_variable_positions()
      • CircuitTemplate.intermediate_representation
      • CircuitTemplate.run()
      • CircuitTemplate.state
      • CircuitTemplate.target_ir
      • CircuitTemplate.to_yaml()
      • CircuitTemplate.update_template()
      • CircuitTemplate.update_var()
    • create_input_node()
    • is_integration_adaptive()
    • update_dict()
    • update_edges()
  • 1.3.1.1.4. pyrates.frontend.template.node module
    • NodeTemplate
      • NodeTemplate.target_ir()
  • 1.3.1.1.5. pyrates.frontend.template.edge module
    • EdgeTemplate
      • EdgeTemplate.target_ir()
  • 1.3.1.1.6. pyrates.frontend.template.operator module
    • OperatorTemplate
      • OperatorTemplate.__getitem__()
      • OperatorTemplate.apply()
      • OperatorTemplate.cache
      • OperatorTemplate.target_ir
      • OperatorTemplate.update_template()
    • check_vname()
  • 1.3.1.1.7. pyrates.frontend.template.operator_graph module
    • OperatorGraphTemplate
      • OperatorGraphTemplate.__getitem__()
      • OperatorGraphTemplate.apply()
      • OperatorGraphTemplate.get_op()
      • OperatorGraphTemplate.target_ir()
      • OperatorGraphTemplate.update_template()
      • OperatorGraphTemplate.update_var()
• 1.3.1.2. PyRates.pyrates.frontend.fileio
  • 1.3.1.2.1. pyrates.frontend.fileio module
    • save()
  • 1.3.1.2.2. pyrates.frontend.fileio.pickle module
    • dump()
    • load()
  • 1.3.1.2.3. pyrates.frontend.fileio.yaml module
    • dict_from_yaml()
    • dump_to_yaml()

1.3.2. pyrates.frontend.dict module

pyrates.frontend.dict.add_to_dict(template, template_dict: dict, full_dict: dict)

pyrates.frontend.dict.from_circuit(circuit: CircuitTemplate, return_dict: dict, base: str = 'CircuitTemplate') → str

Reformat graph structure into a dictionary that can be saved as YAML template. The current implementation assumes that nodes and edges are given by as templates.

pyrates.frontend.dict.from_edge(edge: EdgeTemplate, return_dict: dict, base: str = 'EdgeTemplate') → str | None

Reformat edge template into a list that can be saved as YAML template.

pyrates.frontend.dict.from_node(node: NodeTemplate | EdgeTemplate, return_dict: dict, base: str = 'NodeTemplate') → str

Reformat operator structure into a dictionary that can be saved as YAML template.

pyrates.frontend.dict.from_operator(op: OperatorTemplate, updates: dict, return_dict: dict, base: str = 'OperatorTemplate') → str

Reformat operator template into a dictionary that can be saved as YAML template.

1.3.3. pyrates.frontend.file module

pyrates.frontend.file.parse_path(path: str)

Parse a path of form path.to.template_file.template_name or path/to/template_file/template_name, returning a tuple of (name, file, abspath).

1.3.4. pyrates.frontend.utility module