This guide covers the cfg settings and the reports created

• CFG Sections
  • Logging
  • Machine
  • Database
  • Mapping
  • Reports
  • Buffers
  • Mode
  • EnergyMonitor
  • Java
  • Simulation
  • Recording
• Report Files

  Logging

  This section controls the logger

• default
• instantiate

  default

  Logging Level (in lower case) to be used.

• key: default
• value: info

  instantiate

  Determines if logging is done or not

• key: instantiate
• value: True

  Machine

  This section controls getting a spinnaker machine

• auto_detect_bmp
• bmp_names
• clear_routing_tables
• clear_tags
• disable_advanced_monitor_usage_for_data_in
• down_chips
• down_cores
• down_links
• enable_advanced_monitor_support
• enable_reinjection
• height
• ignore_bad_ethernets
• json_path
• machine_name
• machine_spec_file
• max_machine_core
• max_sdram_allowed_per_chip
• post_simulation_overrun_before_error
• remote_spinnaker_url
• repair_machine
• report_waiting_logs
• reset_machine_on_startup
• simulation_time_step
• spalloc_avoid_boards
• spalloc_group
• spalloc_machine
• spalloc_port
• spalloc_server
• spalloc_use_proxy
• spalloc_user
• time_scale_factor
• turn_off_machine
• version
• versions
• virtual_board
• width

  auto_detect_bmp

• key: auto_detect_bmp
• value: False

  bmp_names

• key: bmp_names
• value: None

  clear_routing_tables

• key: clear_routing_tables
• value: False

  clear_tags

• key: clear_tags
• value: False

  disable_advanced_monitor_usage_for_data_in

• key: disable_advanced_monitor_usage_for_data_in
• value: False

  down_chips

• key: down_chips
• value: None

  down_cores

• key: down_cores
• value: None

  down_links

• key: down_links
• value: None

  enable_advanced_monitor_support

• key: enable_advanced_monitor_support
• value: True

  enable_reinjection

• key: enable_reinjection
• value: True

  height

• key: height
• value: None

  ignore_bad_ethernets

• key: ignore_bad_ethernets
• value: True

  json_path

• key: json_path
• value: None

  machine_name

• key: machine_name
• value: None

  machine_spec_file

  This points to a second cfg file to read the machine details from This allows for easily switching your configs between different baords and spalloc. While designed for Machine settings can include any cfg setting. (Except another machine_spec_file)

• key: machine_spec_file
• value: None

  max_machine_core

• key: max_machine_core
• value: None

  max_sdram_allowed_per_chip

• key: max_sdram_allowed_per_chip
• value: None

  post_simulation_overrun_before_error

• key: post_simulation_overrun_before_error
• value: 5

  remote_spinnaker_url

• key: remote_spinnaker_url
• value: None

  repair_machine

• key: repair_machine
• value: False

  report_waiting_logs

• key: report_waiting_logs
• value: False

  reset_machine_on_startup

• key: reset_machine_on_startup
• value: False

  simulation_time_step

• key: simulation_time_step
• value: 1000

  spalloc_avoid_boards

• key: spalloc_avoid_boards
• value: None

  spalloc_group

• key: spalloc_group
• value: None

  spalloc_machine

• key: spalloc_machine
• value: None

  spalloc_port

• key: spalloc_port
• value: 22244

  spalloc_server

• key: spalloc_server
• value: None

  spalloc_use_proxy

• key: spalloc_use_proxy
• value: True

  spalloc_user

• key: spalloc_user
• value: None

  time_scale_factor

• key: time_scale_factor
• value: None

  turn_off_machine

• key: turn_off_machine
• value: False

  version

• key: version
• value: None

  versions

• key: versions
• value: None

  virtual_board

• key: virtual_board
• value: False

  width

• key: width
• value: None

  Database

• create_database
• create_routing_info_to_neuron_id_mapping
• listen_port
• notify_hostname
• notify_port
• wait_on_confirmation
• wait_on_confirmation_timeout

  create_database

• key: create_database
• value: None

  create_routing_info_to_neuron_id_mapping

• key: create_routing_info_to_neuron_id_mapping
• value: True

  listen_port

• key: listen_port
• value: None

  notify_hostname

• key: notify_hostname
• value: localhost

  notify_port

• key: notify_port
• value: 19999

  wait_on_confirmation

• key: wait_on_confirmation
• value: True

  wait_on_confirmation_timeout

• key: wait_on_confirmation_timeout
• value: 10

  Mapping

• compression_checker
• compressor
• delay_support_adder
• external_binaries
• info_allocator
• placer
• precompressor
• router
• router_table_compress_as_far_as_possible
• routing_table_generator
• validate_json
• validate_routes_uncompressed
• virtual_compressor

  compression_checker

  Trigger

• key: run_compression_checker
• value: Debug

  Path

• key: path_compression_checker
• value: routing_compression_checker_report.rpt

  compressor

• key: compressor
• value: PairOnChipRouterCompression

  delay_support_adder

• key: delay_support_adder
• value: DelaySupportAdder

  external_binaries

• key: external_binaries
• value: None

  info_allocator

• key: info_allocator
• value: ZonedRoutingInfoAllocator

  placer

• key: placer
• value: ApplicationPlacer

  precompressor

• key: precompressor
• value: None

  router

• key: router
• value: ApplicationRouter

  router_table_compress_as_far_as_possible

• key: router_table_compress_as_far_as_possible
• value: False

  routing_table_generator

• key: routing_table_generator
• value: MergedRoutingTableGenerator

  validate_json

• key: validate_json
• value: Debug

  validate_routes_uncompressed

• key: validate_routes_uncompressed
• value: False

  virtual_compressor

• key: virtual_compressor
• value: PairCompressor

  Reports

• algorithm_timings
• application_graph_placer_report
• bit_field_compressor_report
• board_chip_report
• clear_iobuf_during_run
• compressed
• compression_comparison
• compression_summary
• compressor_iobuf
• data_database
• data_speed_up_reports
• dataspec_database
• default_report_file_path
• display_algorithm_timings
• drift_report
• drift_report_ethernet_only
• energy_report
• expander_iobuf
• extract_iobuf
• extract_iobuf_from_binary_types
• extract_iobuf_from_cores
• fixed_routes_report
• ignores_report
• input_output_database
• java_log
• json_files
• json_machine
• json_placements
• json_routing_tables
• max_reports_kept
• memory_map_report
• n_profile_samples
• network_graph
• network_graph_format
• network_specification_report
• partitioner_reports
• placement_errors_report
• placements
• placements_on_error
• provenance
• provenance_report_cutoff
• read_graph_provenance_data
• read_placements_provenance_data
• read_profile_data
• read_provenance_data_on_end
• read_router_provenance_data
• redundant_packet_count_report
• remove_errored_folders
• router_info_report
• router_reports
• router_summary_report
• sdram_usage_report_per_chip
• stack_trace
• tag_allocation_reports
• text_specs
• tpath_algorithm_timings
• tpath_global_provenance
• tpath_stack_trace
• uncompressed

  algorithm_timings

• key: write_algorithm_timings
• value: Debug

  application_graph_placer_report

  Trigger

• key: write_application_graph_placer_report
• value: Info

  Paths

• key: path_application_graph_placer_report_vertex
  • value: placement_by_vertex_using_graph.rpt
• key: path_application_graph_placer_report_core
  • value: placement_by_core_using_graph.rpt

    bit_field_compressor_report

    Trigger

• key: write_bit_field_compressor_report
• value: Debug

  Path

• key: path_bit_field_compressor_report
• value: bit_field_compressed_summary.rpt

  board_chip_report

  Trigger

• key: write_board_chip_report
• value: Debug

  Path

• key: path_board_chip_report
• value: board_chip_report.txt

  clear_iobuf_during_run

• key: clear_iobuf_during_run
• value: True

  compressed

  Trigger

• key: write_compressed
• value: Debug

  Path

• key: path_compressed
• value: compressed_routing_tables_generated

  compression_comparison

  Trigger

• key: write_compression_comparison
• value: Debug

  Path

• key: path_compression_comparison
• value: comparison_of_compressed_uncompressed_routing_tables.rpt

  compression_summary

  Trigger

• key: write_compression_summary
• value: Debug

  Path

• key: path_compression_summary
• value: compressed_routing_summary.rpt

  compressor_iobuf

• key: write_compressor_iobuf
• value: Debug

  data_database

  Trigger

• key: keep_data_database
• value: Info

  Path

• key: path_data_database
• value: data(reset_str).sqlite3

  data_speed_up_reports

  Trigger

• key: write_data_speed_up_reports
• value: Debug

  Paths

• key: path_data_speed_up_reports_speeds
  • value: speeds_gained_in_speed_up_process.rpt
• key: path_data_speed_up_reports_routers
  • value: routers_used_in_speed_up_process.rpt

    dataspec_database

    Trigger

• key: keep_dataspec_database
• value: Debug

  Path

• key: path_dataspec_database
• value: ds(reset_str).sqlite3

  default_report_file_path

• key: default_report_file_path
• value: DEFAULT

  display_algorithm_timings

• key: display_algorithm_timings
• value: True

  drift_report

  Triggers

• key: write_drift_report_start
  • value: Debug
• key: write_drift_report_end
  • value: Debug

    Path

• key: path_drift_report
• value: clock_drift.csv

  drift_report_ethernet_only

• key: drift_report_ethernet_only
• value: True

  energy_report

  Trigger

• key: write_energy_report
• value: False

  Path

• key: path_energy_report
• value: energy_report_(n_run).rpt

  expander_iobuf

• key: write_expander_iobuf
• value: Debug

  extract_iobuf

  Trigger

• key: extract_iobuf
• value: Debug

  Paths

• key: path_iobuf_app
  • value: provenance_data\app_provenance_data
• key: path_iobuf_system
  • value: provenance_data\system_provenance_data

    extract_iobuf_from_binary_types

• key: extract_iobuf_from_binary_types
• value: None

  extract_iobuf_from_cores

• key: extract_iobuf_from_cores
• value: ALL

  fixed_routes_report

  Trigger

• key: write_fixed_routes_report
• value: Debug

  Path

• key: path_fixed_routes_report
• value: fixed_route_routers

  ignores_report

  always written if there is a down core, chip or link declared

  Path

• key: path_ignores_report
• value: Ignores_report.rpt

  input_output_database

  Trigger

• key: keep_input_output_database
• value: Info

  Path

• key: path_input_output_database
• value: input_output_database.sqlite3

  java_log

  Trigger

• key: keep_java_log
• value: Debug

  Path

• key: path_java_log
• value: jspin.log

  json_files

• key: keep_json_files
• value: Debug

  json_machine

  Trigger

• key: write_json_machine
• value: Debug

  Path

• key: path_json_machine
• value: json_files\machine.json

  json_placements

  Trigger

• key: write_json_placements
• value: Debug

  Path

• key: path_json_placements
• value: json_files\placements.json

  json_routing_tables

  Trigger

• key: write_json_routing_tables
• value: Debug

  Path

• key: path_json_routing_tables
• value: json_files\routing_tables.json

  max_reports_kept

• key: max_reports_kept
• value: 10

  memory_map_report

  Trigger

• key: write_memory_map_report
• value: Debug

  Paths

• key: path_memory_map_report_map
  • value: memory_map_from_processor_to_address_space
• key: path_memory_map_reports
  • value: memory_map_reports

    n_profile_samples

• key: n_profile_samples
• value: 0

  network_graph

  Trigger

• key: write_network_graph
• value: Debug

  Path

• key: path_network_graph
• value: network_graph.gv

  network_graph_format

• key: network_graph_format
• value: None

  network_specification_report

  Trigger

• key: write_network_specification_report
• value: Info

  Path

• key: path_network_specification_report
• value: network_specification.rpt

  partitioner_reports

  Trigger

• key: write_partitioner_reports
• value: Info

  Path

• key: path_partitioner_reports
• value: partitioned_by_vertex.rpt

  placement_errors_report

  Always run if needed

  Path

• key: path_placement_errors_report
• value: placements_error.txt

  placements

  Trigger

• key: draw_placements
• value: False

  Path

• key: path_placements
• value: placements.png

  placements_on_error

  Trigger

• key: draw_placements_on_error
• value: False

  Path

• key: path_placements_on_error
• value: placements_error.png

  provenance

• key: write_provenance
• value: Info

  provenance_report_cutoff

• key: provenance_report_cutoff
• value: 20

  read_graph_provenance_data

• key: read_graph_provenance_data
• value: Debug

  read_placements_provenance_data

• key: read_placements_provenance_data
• value: Debug

  read_profile_data

• key: read_profile_data
• value: Debug

  read_provenance_data_on_end

• key: read_provenance_data_on_end
• value: Debug

  read_router_provenance_data

• key: read_router_provenance_data
• value: Debug

  redundant_packet_count_report

  Trigger

• key: write_redundant_packet_count_report
• value: Info

  Path

• key: path_redundant_packet_count_report
• value: redundant_packet_count.rpt

  remove_errored_folders

• key: remove_errored_folders
• value: True

  router_info_report

  Trigger

• key: write_router_info_report
• value: Info

  Path

• key: path_router_info_report
• value: virtual_key_space_information_report.rpt

  router_reports

  Trigger

• key: write_router_reports
• value: Debug

  Path

• key: path_router_reports
• value: edge_routing_info.rpt

  router_summary_report

  Trigger

• key: write_router_summary_report
• value: Debug

  Path

• key: path_router_summary_report
• value: routing_summary.rpt

  sdram_usage_report_per_chip

  Trigger

• key: write_sdram_usage_report_per_chip
• value: Info

  Path

• key: path_sdram_usage_report_per_chip
• value: chip_sdram_usage_by_core.rpt

  stack_trace

• key: keep_stack_trace
• value: Info

  tag_allocation_reports

  Trigger

• key: write_tag_allocation_reports
• value: Debug

  Paths

• key: path_tag_allocation_reports_host
  • value: tags.rpt
• key: path_tag_allocation_reports_machine
  • value: tags_on_machine.txt

    text_specs

    Trigger

• key: write_text_specs
• value: Debug

  Path

• key: path_text_specs
• value: data_spec_text_files

  tpath_algorithm_timings

• key: tpath_algorithm_timings
• value: algorithm_timings.rpt

  tpath_global_provenance

• key: tpath_global_provenance
• value: global_provenance.sqlite3

  tpath_stack_trace

• key: tpath_stack_trace
• value: stack_trace

  uncompressed

  Trigger

• key: write_uncompressed
• value: Debug

  Path

• key: path_uncompressed
• value: routing_tables_generated

  Buffers

• minimum_auto_time_steps
• use_auto_pause_and_resume

  minimum_auto_time_steps

• key: minimum_auto_time_steps
• value: 1000

  use_auto_pause_and_resume

• key: use_auto_pause_and_resume
• value: True

  Mode

• mode
• violate_1ms_wall_clock_restriction

  mode

• key: mode
• value: Production

  violate_1ms_wall_clock_restriction

• key: violate_1ms_wall_clock_restriction
• value: False

  EnergyMonitor

• n_samples_per_recording_entry
• sampling_frequency

  n_samples_per_recording_entry

• key: n_samples_per_recording_entry
• value: 100

  sampling_frequency

• key: sampling_frequency
• value: 10

  Java

• java_call
• java_jar_path
• java_properties
• java_spinnaker_path
• use_java

  java_call

• key: java_call
• value: java

  java_jar_path

• key: java_jar_path
• value: None

  java_properties

• key: java_properties
• value: None

  java_spinnaker_path

• key: java_spinnaker_path
• value: None

  use_java

  Trigger

• key: use_java
• value: False

  Path

• key: path_json_java_placements
• value: json_files\java_placements.json

  Simulation

• drop_late_spikes
• error_on_non_spynnaker_pynn
• incoming_spike_buffer_size
• n_colour_bits
• ring_buffer_sigma
• spikes_per_second
• transfer_overhead_clocks

  drop_late_spikes

• key: drop_late_spikes
• value: False

  error_on_non_spynnaker_pynn

• key: error_on_non_spynnaker_pynn
• value: True

  incoming_spike_buffer_size

• key: incoming_spike_buffer_size
• value: 256

  n_colour_bits

• key: n_colour_bits
• value: 4

  ring_buffer_sigma

• key: ring_buffer_sigma
• value: 5

  spikes_per_second

• key: spikes_per_second
• value: 30

  transfer_overhead_clocks

• key: transfer_overhead_clocks
• value: 200

  Recording

• live_spike_host
• live_spike_port

  live_spike_host

• key: live_spike_host
• value: 0.0.0.0

  live_spike_port

• key: live_spike_port
• value: 17895

  Report Files

  • Ignores_report.rpt
  • bit_field_compressed_summary.rpt
  • board_chip_report.txt
  • chip_sdram_usage_by_core.rpt
  • clock_drift.csv
  • comparison_of_compressed_uncompressed_routing_tables.rpt
  • compressed_routing_summary.rpt
  • compressed_routing_tables_generated
  • data(reset_str).sqlite3
  • data_spec_text_files
  • ds(reset_str).sqlite3
  • edge_routing_info.rpt
  • energy_report_(n_run).rpt
  • fixed_route_routers
  • input_output_database.sqlite3
  • json_files\java_placements.json
  • json_files\machine.json
  • json_files\placements.json
  • json_files\routing_tables.json
  • jspin.log
  • memory_map_from_processor_to_address_space
  • memory_map_reports
  • network_graph.gv
  • network_specification.rpt
  • partitioned_by_vertex.rpt
  • placement_by_core_using_graph.rpt
  • placement_by_vertex_using_graph.rpt
  • placements.png
  • placements_error.png
  • placements_error.txt
  • provenance_data\app_provenance_data
  • provenance_data\system_provenance_data
  • redundant_packet_count.rpt
  • routers_used_in_speed_up_process.rpt
  • routing_compression_checker_report.rpt
  • routing_summary.rpt
  • routing_tables_generated
  • speeds_gained_in_speed_up_process.rpt
  • tags.rpt
  • tags_on_machine.txt
  • virtual_key_space_information_report.rpt