spinn_front_end_common.utilities.report_functions package

Submodules

spinn_front_end_common.utilities.report_functions.energy_report module

class spinn_front_end_common.utilities.report_functions.energy_report.EnergyReport[source]

Bases: object

This class creates a report about the approximate total energy consumed by a SpiNNaker job execution.

JOULES_TO_KILOWATT_HOURS = 3600000

converter between joules to kilowatt hours

write_energy_report(power_used)[source]

Writes the report.

Parameters:

Module contents

spinn_front_end_common.utilities.report_functions.bitfield_compressor_report()[source]

Generates a report that shows the impact of the compression of bitfields into the routing table.

Returns:a summary, or None if the report file can’t be written
Return type:BitFieldSummary
class spinn_front_end_common.utilities.report_functions.BitFieldSummary(total_merged, max_per_chip, lowest_per_chip, total_to_merge, max_to_merge_per_chip, low_to_merge_per_chip, average_per_chip_merged, average_per_chip_to_merge)[source]

Bases: object

Summary description of generated bitfields.

Parameters:
  • total_merged (int) –
  • max_per_chip (int) –
  • lowest_per_chip (int) –
  • total_to_merge (int) –
  • max_to_merge_per_chip (int) –
  • low_to_merge_per_chip (int) –
  • average_per_chip_merged (float) –
  • average_per_chip_to_merge (float) –
average_per_chip_merged
Return type:float
average_per_chip_to_merge
Return type:float
low_to_merge_per_chip
Return type:int
lowest_per_chip
Return type:int
max_per_chip
Return type:int
max_to_merge_per_chip
Return type:int
total_merged
Return type:int
total_to_merge
Return type:int
spinn_front_end_common.utilities.report_functions.board_chip_report()[source]

Creates a report that states where in SDRAM each region is.

class spinn_front_end_common.utilities.report_functions.EnergyReport[source]

Bases: object

This class creates a report about the approximate total energy consumed by a SpiNNaker job execution.

JOULES_TO_KILOWATT_HOURS = 3600000

converter between joules to kilowatt hours

write_energy_report(power_used)[source]

Writes the report.

Parameters:
spinn_front_end_common.utilities.report_functions.fixed_route_from_machine_report()[source]

Writes the fixed routes from the machine.

spinn_front_end_common.utilities.report_functions.network_specification()[source]

Generate report on the user’s network specification.

spinn_front_end_common.utilities.report_functions.memory_map_on_host_chip_report()[source]

Report on memory usage. Creates a report that states where in SDRAM each region is (read from machine).

spinn_front_end_common.utilities.report_functions.memory_map_on_host_report()[source]

Report on memory usage.

spinn_front_end_common.utilities.report_functions.router_collision_potential_report()[source]
spinn_front_end_common.utilities.report_functions.routing_table_from_machine_report(routing_tables)[source]

Report the routing table that was actually on the machine.

folder_name = os.path.join(FecDataView().run_dir_path, _FOLDER_NAME) os.mkdir(folder_name)
Parameters:
spinn_front_end_common.utilities.report_functions.tags_from_machine_report()[source]

Describes what the tags actually present on the machine are.

spinn_front_end_common.utilities.report_functions.write_json_machine(json_folder=None, progress_bar=True, validate=True)[source]

Runs the code to write the machine in Java readable JSON.

Warning

The file in this folder will be overwritten!

Parameters:
  • json_folder (str) – the folder to which the JSON are being written
  • progress_bar (bool) – Flag if Progress Bar should be shown
  • validate (bool) – Flag to disable the validation.
Returns:

the name of the generated file
Return type:

str
spinn_front_end_common.utilities.report_functions.write_json_placements()[source]

Runs the code to write the placements in JSON.

spinn_front_end_common.utilities.report_functions.write_json_routing_tables(router_tables)[source]

Runs the code to write the machine in Java readable JSON.

Parameters:
  • router_tables (MulticastRoutingTables) – Routing Tables to convert. Could be uncompressed or compressed
  • json_folder (str) – the folder to which the JSON are being written
spinn_front_end_common.utilities.report_functions.drift_report()[source]

A report on the clock drift as reported by each chip