SpiNNUtils

Contents

• spinn_utilities
  • spinn_utilities package
    • Subpackages
      • spinn_utilities.citation package
        • Module contents
          • CitationAggregator
            • CitationAggregator.create_aggregated_citation_file()
            • CitationAggregator.locate_path_for_c_dependency()
          • CitationUpdaterAndDoiGenerator
            • CitationUpdaterAndDoiGenerator.convert_month_name_to_number()
            • CitationUpdaterAndDoiGenerator.convert_text_date_to_date()
            • CitationUpdaterAndDoiGenerator.update_citation_file_and_create_doi()
          • generate_aggregate()
      • spinn_utilities.configs package
        • Submodules
        • spinn_utilities.configs.config_checker module
          • ConfigChecker
            • ConfigChecker.check()
        • spinn_utilities.configs.config_documentor module
          • ConfigDocumentor
            • ConfigDocumentor.check()
            • ConfigDocumentor.md_configs()
            • ConfigDocumentor.md_notes()
            • ConfigDocumentor.md_reports()
            • ConfigDocumentor.print_configs()
            • ConfigDocumentor.print_section()
        • spinn_utilities.configs.two_user_configs_exception module
          • TwoUserConfigsException
        • Module contents
          • CamelCaseConfigParser
            • CamelCaseConfigParser.optionxform()
          • ConfigTemplateException
          • NoConfigFoundException
          • UnexpectedConfigException
      • spinn_utilities.data package
        • Submodules
        • spinn_utilities.data.reset_status module
          • ResetStatus
            • ResetStatus.HARD_RESET
            • ResetStatus.HAS_RUN
            • ResetStatus.NOT_SETUP
            • ResetStatus.SETUP
            • ResetStatus.SOFT_RESET
        • spinn_utilities.data.run_status module
          • RunStatus
            • RunStatus.IN_RUN
            • RunStatus.NOT_RUNNING
            • RunStatus.NOT_SETUP
            • RunStatus.SHUTDOWN
            • RunStatus.STOPPING
            • RunStatus.STOP_REQUESTED
        • spinn_utilities.data.utils_data_writer module
          • UtilsDataWriter
            • UtilsDataWriter.ERRORED_FILENAME
            • UtilsDataWriter.FINISHED_FILENAME
            • UtilsDataWriter.REPORTS_DIRNAME
            • UtilsDataWriter.finish_run()
            • UtilsDataWriter.get_report_dir_path()
            • UtilsDataWriter.hard_reset()
            • UtilsDataWriter.mock()
            • UtilsDataWriter.request_stop()
            • UtilsDataWriter.set_report_dir_path()
            • UtilsDataWriter.set_run_dir_path()
            • UtilsDataWriter.setup()
            • UtilsDataWriter.shut_down()
            • UtilsDataWriter.soft_reset()
            • UtilsDataWriter.start_run()
            • UtilsDataWriter.stopping()
            • UtilsDataWriter.write_errored_file()
            • UtilsDataWriter.write_finished_file()
        • Module contents
          • DataStatus
            • DataStatus.MOCKED
            • DataStatus.NOT_SETUP
            • DataStatus.SETUP
            • DataStatus.SHUTDOWN
            • DataStatus.exception()
          • UtilsDataView
            • UtilsDataView.check_user_can_act()
            • UtilsDataView.check_valid_simulator()
            • UtilsDataView.get_error_file()
            • UtilsDataView.get_executable_finder()
            • UtilsDataView.get_executable_path()
            • UtilsDataView.get_executable_paths()
            • UtilsDataView.get_global_reports_dir()
            • UtilsDataView.get_requires_data_generation()
            • UtilsDataView.get_requires_mapping()
            • UtilsDataView.get_reset_number()
            • UtilsDataView.get_reset_str()
            • UtilsDataView.get_run_dir_path()
            • UtilsDataView.get_run_number()
            • UtilsDataView.get_timestamp_dir_path()
            • UtilsDataView.is_hard_reset()
            • UtilsDataView.is_no_stop_requested()
            • UtilsDataView.is_ran_ever()
            • UtilsDataView.is_ran_last()
            • UtilsDataView.is_reset_last()
            • UtilsDataView.is_running()
            • UtilsDataView.is_setup()
            • UtilsDataView.is_shutdown()
            • UtilsDataView.is_soft_reset()
            • UtilsDataView.is_stop_already_requested()
            • UtilsDataView.is_user_mode()
            • UtilsDataView.raise_skiptest()
            • UtilsDataView.register_binary_search_path()
            • UtilsDataView.set_requires_data_generation()
            • UtilsDataView.set_requires_mapping()
      • spinn_utilities.make_tools package
        • Submodules
        • spinn_utilities.make_tools.converter module
          • convert()
        • spinn_utilities.make_tools.log_sqllite_database module
          • LogSqlLiteDatabase
            • LogSqlLiteDatabase.check_original()
            • LogSqlLiteDatabase.close()
            • LogSqlLiteDatabase.get_directory_id()
            • LogSqlLiteDatabase.get_file_id()
            • LogSqlLiteDatabase.get_log_info()
            • LogSqlLiteDatabase.get_max_log_id()
            • LogSqlLiteDatabase.set_log_info()
        • spinn_utilities.make_tools.replacer module
          • Replacer
            • Replacer.replace()
        • Module contents
          • FileConverter
            • FileConverter.__call__()
            • FileConverter.convert()
      • spinn_utilities.ranged package
        • Submodules
        • spinn_utilities.ranged.ids_view module
        • spinn_utilities.ranged.single_view module
        • spinn_utilities.ranged.slice_view module
        • Module contents
          • AbstractDict
            • AbstractDict.get_default()
            • AbstractDict.get_ranges()
            • AbstractDict.get_value()
            • AbstractDict.has_key()
            • AbstractDict.ids()
            • AbstractDict.items()
            • AbstractDict.iter_all_values()
            • AbstractDict.iter_ranges()
            • AbstractDict.iteritems()
            • AbstractDict.itervalues()
            • AbstractDict.keys()
            • AbstractDict.reset()
            • AbstractDict.set_value()
            • AbstractDict.values()
          • AbstractList
            • AbstractList.apply_operation()
            • AbstractList.count()
            • AbstractList.get_default()
            • AbstractList.get_single_value_all()
            • AbstractList.get_single_value_by_ids()
            • AbstractList.get_single_value_by_slice()
            • AbstractList.get_value_by_id()
            • AbstractList.get_values()
            • AbstractList.index()
            • AbstractList.iter()
            • AbstractList.iter_by_id()
            • AbstractList.iter_by_ids()
            • AbstractList.iter_by_selector()
            • AbstractList.iter_by_slice()
            • AbstractList.iter_ranges()
            • AbstractList.iter_ranges_by_id()
            • AbstractList.iter_ranges_by_ids()
            • AbstractList.iter_ranges_by_slice()
            • AbstractList.range_based()
          • AbstractSized
            • AbstractSized.selector_to_ids()
          • AbstractView
            • AbstractView.get_default()
            • AbstractView.ids()
            • AbstractView.keys()
            • AbstractView.set_value()
          • DualList
            • DualList.get_default()
            • DualList.get_single_value_by_ids()
            • DualList.get_single_value_by_slice()
            • DualList.get_value_by_id()
            • DualList.iter_by_slice()
            • DualList.iter_ranges()
            • DualList.iter_ranges_by_slice()
            • DualList.range_based()
          • MultipleValuesException
          • RangeDictionary
            • RangeDictionary.copy()
            • RangeDictionary.copy_into()
            • RangeDictionary.get_default()
            • RangeDictionary.get_list()
            • RangeDictionary.get_value()
            • RangeDictionary.get_values_by_id()
            • RangeDictionary.has_key()
            • RangeDictionary.ids()
            • RangeDictionary.iter_all_values()
            • RangeDictionary.iter_ranges()
            • RangeDictionary.iter_ranges_by_id()
            • RangeDictionary.iter_ranges_by_ids()
            • RangeDictionary.iter_ranges_by_slice()
            • RangeDictionary.iter_values_by_ids()
            • RangeDictionary.iter_values_by_slice()
            • RangeDictionary.keys()
            • RangeDictionary.list_factory()
            • RangeDictionary.set_default()
            • RangeDictionary.set_value()
            • RangeDictionary.update_safe_iter_all_values()
            • RangeDictionary.view_factory()
          • RangedList
            • RangedList.as_list()
            • RangedList.copy()
            • RangedList.copy_into()
            • RangedList.get_default()
            • RangedList.get_ranges()
            • RangedList.get_single_value_by_ids()
            • RangedList.get_single_value_by_slice()
            • RangedList.get_value_by_id()
            • RangedList.is_list()
            • RangedList.iter_by_slice()
            • RangedList.iter_ranges()
            • RangedList.iter_ranges_by_slice()
            • RangedList.listness_check()
            • RangedList.range_based()
            • RangedList.set_default()
            • RangedList.set_value()
            • RangedList.set_value_by_id()
            • RangedList.set_value_by_ids()
            • RangedList.set_value_by_selector()
            • RangedList.set_value_by_slice()
          • RangedListOfList
            • RangedListOfList.listness_check()
          • SingleList
            • SingleList.get_default()
            • SingleList.get_single_value_by_ids()
            • SingleList.get_single_value_by_slice()
            • SingleList.get_value_by_id()
            • SingleList.iter_ranges()
            • SingleList.iter_ranges_by_slice()
            • SingleList.range_based()
      • spinn_utilities.testing package
        • Submodules
        • spinn_utilities.testing.docs_checker module
          • DocsChecker
            • DocsChecker.check_dir()
            • DocsChecker.check_file()
            • DocsChecker.check_function()
            • DocsChecker.check_no_errors()
            • DocsChecker.get_param_names()
            • DocsChecker.has_returns()
            • DocsChecker.is_not_overload()
            • DocsChecker.is_property()
        • spinn_utilities.testing.log_checker module
          • assert_logs_contains_once()
          • assert_logs_error_contains()
          • assert_logs_error_not_contains()
          • assert_logs_info_contains()
          • assert_logs_info_not_contains()
          • assert_logs_warning_contains()
        • Module contents
      • spinn_utilities.typing package
        • Submodules
        • spinn_utilities.typing.coords module
          • XY
          • XYP
        • spinn_utilities.typing.json module
          • JsonArray
          • JsonObject
          • JsonObjectArray
          • JsonValue
        • Module contents
    • Submodules
    • spinn_utilities.abstract_base module
      • AbstractBase
      • abstractmethod()
    • spinn_utilities.abstract_context_manager module
      • AbstractContextManager
        • AbstractContextManager.close()
    • spinn_utilities.bytestring_utils module
      • as_hex()
      • as_string()
    • spinn_utilities.classproperty module
      • classproperty()
    • spinn_utilities.conf_loader module
      • load_config()
      • load_defaults()
    • spinn_utilities.config_holder module
      • add_default_cfg()
      • add_template()
      • clear_cfg_files()
      • config_options()
      • config_sections()
      • configs_loaded()
      • get_config_bool()
      • get_config_bool_or_none()
      • get_config_float()
      • get_config_float_or_none()
      • get_config_int()
      • get_config_int_or_none()
      • get_config_str()
      • get_config_str_list()
      • get_config_str_or_none()
      • get_default_cfgs()
      • get_report_path()
      • get_timestamp_path()
      • has_config_option()
      • is_config_none()
      • load_config()
      • logging_parser()
      • set_cfg_files()
      • set_config()
    • spinn_utilities.config_setup module
      • add_spinn_utilities_cfg()
      • unittest_setup()
    • spinn_utilities.exceptions module
      • ConfigException
      • DataNotMocked
      • DataNotYetAvialable
      • IllegalWriterException
      • InvalidDirectory
      • NotSetupException
      • ShutdownException
      • SimulatorNotRunException
      • SimulatorNotSetupException
      • SimulatorRunningException
      • SimulatorShutdownException
      • SpiNNUtilsException
      • UnexpectedCException
      • UnexpectedStateChange
    • spinn_utilities.executable_finder module
      • ExecutableFinder
        • ExecutableFinder.add_path()
        • ExecutableFinder.binary_paths
        • ExecutableFinder.check_logs()
        • ExecutableFinder.clear_logs()
        • ExecutableFinder.get_executable_path()
        • ExecutableFinder.get_executable_paths()
    • spinn_utilities.find_max_success module
      • find_max_success()
      • search_for_max_success()
    • spinn_utilities.helpful_functions module
      • gcd()
      • is_singleton()
      • lcm()
    • spinn_utilities.log module
      • ConfiguredFilter
        • ConfiguredFilter.filter()
      • ConfiguredFormatter
        • ConfiguredFormatter.construct_logging_parents()
        • ConfiguredFormatter.deepest_parent()
        • ConfiguredFormatter.level_of_deepest_parent()
      • FormatAdapter
        • FormatAdapter.atexit_handler()
        • FormatAdapter.log()
        • FormatAdapter.process()
        • FormatAdapter.set_kill_level()
        • FormatAdapter.set_log_store()
      • LogLevelTooHighException
    • spinn_utilities.log_store module
      • LogStore
        • LogStore.get_location()
        • LogStore.retreive_log_messages()
        • LogStore.store_log()
    • spinn_utilities.logger_utils module
      • error_once()
      • reset()
      • warn_once()
    • spinn_utilities.ordered_set module
      • OrderedSet
        • OrderedSet.add()
        • OrderedSet.discard()
        • OrderedSet.peek()
        • OrderedSet.pop()
        • OrderedSet.update()
    • spinn_utilities.overrides module
      • overrides
        • overrides.__call__()
    • spinn_utilities.package_loader module
      • all_modules()
      • load_module()
      • load_modules()
    • spinn_utilities.ping module
      • Ping
        • Ping.host_is_reachable()
        • Ping.ping()
        • Ping.unreachable
    • spinn_utilities.progress_bar module
      • DummyProgressBar
      • ProgressBar
        • ProgressBar.MAX_LENGTH_IN_CHARS
        • ProgressBar.TOO_MANY_ERROR
        • ProgressBar.end()
        • ProgressBar.over()
        • ProgressBar.update()
    • spinn_utilities.require_subclass module
      • require_subclass()
    • spinn_utilities.safe_eval module
      • SafeEval
        • SafeEval.eval()
    • spinn_utilities.socket_address module
      • SocketAddress
        • SocketAddress.listen_port
        • SocketAddress.notify_host_name
        • SocketAddress.notify_port_no
    • spinn_utilities.timer module
      • Timer
        • Timer.measured_interval
        • Timer.start_timing()
        • Timer.take_sample()
    • Module contents

Indices and tables

• Index

• Module Index

• Search Page