agentMET4FOF
latest

Getting started:

  • Multi-Agent System for IIoT
    • Key facts
    • Table of content
    • 💫Quickstart
    • 💬About
      • Features
    • 📈The agentMET4FOF dashboard
    • 🤓Tutorials
    • 📖Documentation and screencasts
      • Screencast series
      • Live online tutorial during early development
    • 💻Installation
    • 🐝Contributing
    • 💨Coming soon
    • 🖋Citation
    • 💎Acknowledgement
    • ⚠Disclaimer
    • ©License

Detailed information:

  • Installation of agentMET4FOF
    • Install agentMET4FOF as a Python package
      • Set up a virtual environment
        • Create a venv Python environment on Windows
        • Create a venv Python environment on Mac & Linux
        • Create an Anaconda Python environment
      • Install agentMET4FOF via pip
    • Use agentMET4FOF from inside a Docker container
      • Install Docker
      • Start a container from the image for local use
      • Deploy the containerized agents via a webserver
        • Start the container with the dashboard at a subfolder
        • Configure the Nginx
  • Changelog
    • v0.13.3 (2024-05-15)
      • Fix
      • Refactor
      • Documentation
    • v0.13.2 (2022-02-03)
      • Fix
      • Refactor
    • v0.13.1 (2022-02-01)
      • Fix
      • Refactor
    • v0.13.0 (2021-11-12)
      • Feature
      • Documentation
    • v0.12.1 (2021-08-27)
      • Fix
    • v0.12.0 (2021-07-30)
      • Feature
      • Refactor
      • Documentation
    • v0.11.0 (2021-07-29)
      • Feature
      • Fix
      • Refactor
      • Documentation
    • v0.10.1 (2021-07-23)
      • Fix
      • Refactor
      • Documentation
    • v0.10.0 (2021-07-21)
      • Feature
      • Refactor
      • Documentation
    • v0.9.0 (2021-07-08)
      • Feature
      • Fix
      • Refactor
      • Documentation
    • v0.8.1 (2021-06-10)
    • v0.8.0 (2021-06-10)
      • Feature
      • Documentation
    • v0.7.0 (2021-06-04)
      • Feature
      • Fix
      • Documentation
    • v0.6.4 (2021-05-06)
      • Fix
    • v0.6.3 (2021-04-28)
      • Fix
      • Documentation
    • v0.6.2 (2021-03-19)
      • Fix
      • Documentation
    • v0.6.1 (2021-03-12)
      • Fix
      • Documentation
  • Contributor Covenant Code of Conduct
    • Our Pledge
    • Our Standards
    • Enforcement Responsibilities
    • Scope
    • Enforcement
    • Enforcement Guidelines
      • 1. Correction
      • 2. Warning
      • 3. Temporary Ban
      • 4. Permanent Ban
    • Attribution
  • Contribute to agentMET4FOF
    • Guiding principles
      • Get the code on GitHub and locally
      • Initial development setup
      • Advised toolset
      • Coding style
      • Commit messages
        • Commit message structure
        • Commit message styling
        • BREAKING CHANGEs
        • Commit message examples
      • Testing
    • Workflow for adding completely new functionality
    • Documentation
      • User documentation
      • Examples
      • Comments in the code
    • Manage dependencies
    • Licensing

Tutorials:

  • Learning how to use the agents
    • Tutorial 1 - A simple pipeline to plot a signal
    • Tutorial 2 - A simple pipeline with signal postprocessing.
    • Tutorial 3 - An advanced pipeline with multichannel signals.
    • Tutorial 4 - A metrological datastream
    • Tutorial 5 - Building coalitions
    • Tutorial 6 - Using a different backend
    • Tutorial 7 - Generating signals using a generic metrological agent
    • Tutorial 8 - A simple pipeline to plot a self-made signal
  • Working with signals carrying redundant information
    • Redundancy Agent – Determining redundancy in several similar signals
    • Redundancy Agent – Determining redundancy in one single signal
  • Reducing noise and jitter in signals
    • Noise-Jitter Removal Agent – Remove noise and jitter from signals

Code Reference:

  • agentMET4FOF agents
    • Base agents
      • AgentMET4FOF
        • AgentMET4FOF._bind_output()
        • AgentMET4FOF._convert_matplotlib_fig()
        • AgentMET4FOF._convert_to_plotly()
        • AgentMET4FOF._fig_to_uri()
        • AgentMET4FOF._get_metadata()
        • AgentMET4FOF._is_type_message()
        • AgentMET4FOF._remove_methods()
        • AgentMET4FOF._update_output_channels_info()
        • AgentMET4FOF.agent_loop()
        • AgentMET4FOF.bind_output()
        • AgentMET4FOF.buffer_clear()
        • AgentMET4FOF.buffer_filled()
        • AgentMET4FOF.buffer_store()
        • AgentMET4FOF.get_attr()
        • AgentMET4FOF.handle_process_data()
        • AgentMET4FOF.init_agent()
        • AgentMET4FOF.Inputs
        • AgentMET4FOF.Outputs
        • AgentMET4FOF.PubAddr_alias
        • AgentMET4FOF.PubAddr
        • AgentMET4FOF.AgentType
        • AgentMET4FOF.current_state
        • AgentMET4FOF.loop_wait
        • AgentMET4FOF.buffer_size
        • AgentMET4FOF.init_agent_loop()
        • AgentMET4FOF.init_buffer()
        • AgentMET4FOF.init_parameters()
        • AgentMET4FOF.log_info()
        • AgentMET4FOF.on_connect_output()
        • AgentMET4FOF.on_received_message()
        • AgentMET4FOF.pack_data()
        • AgentMET4FOF.reset()
        • AgentMET4FOF.respond_reply_attr_()
        • AgentMET4FOF.respond_request_attr_()
        • AgentMET4FOF.respond_request_method_()
        • AgentMET4FOF.send_output()
        • AgentMET4FOF.send_plot()
        • AgentMET4FOF.send_request_attribute()
        • AgentMET4FOF.send_request_method()
        • AgentMET4FOF.send_set_attr()
        • AgentMET4FOF.set_attr()
        • AgentMET4FOF.shutdown()
        • AgentMET4FOF.step()
        • AgentMET4FOF.stop_agent_loop()
        • AgentMET4FOF.unbind_output()
      • DataStreamAgent
        • DataStreamAgent.agent_loop()
        • DataStreamAgent.init_parameters()
        • DataStreamAgent.reset()
      • MonitorAgent
        • MonitorAgent.plots
        • MonitorAgent.plot_filter
        • MonitorAgent.custom_plot_function
        • MonitorAgent.custom_plot_parameters
        • MonitorAgent.init_parameters()
        • MonitorAgent.on_received_message()
        • MonitorAgent.reset()
        • MonitorAgent.update_plot_memory()
    • Signal agents
      • NoiseAgent
        • NoiseAgent.init_parameters()
        • NoiseAgent.noise_std
        • NoiseAgent.on_received_message()
      • SineGeneratorAgent
        • SineGeneratorAgent.agent_loop()
        • SineGeneratorAgent.init_parameters()
      • SineWithJitterGeneratorAgent
        • SineWithJitterGeneratorAgent.agent_loop()
        • SineWithJitterGeneratorAgent.init_parameters()
      • StaticSineWithJitterGeneratorAgent
        • StaticSineWithJitterGeneratorAgent.agent_loop()
        • StaticSineWithJitterGeneratorAgent.init_parameters()
    • An agent to reduce noise and jitter in a signal
      • MCMCMHNJ
        • MCMCMHNJ.AnalyseSignalN()
        • MCMCMHNJ.NJAlgorithm()
        • MCMCMHNJ.fgh_cubic()
        • MCMCMHNJ.jumprwg()
        • MCMCMHNJ.ln_gauss_pdf_v()
        • MCMCMHNJ.mcmcci()
        • MCMCMHNJ.mcmcmh()
        • MCMCMHNJ.mcsums()
        • MCMCMHNJ.tar_at()
      • NoiseJitterRemovalAgent
        • NoiseJitterRemovalAgent.init_parameters()
        • NoiseJitterRemovalAgent.on_received_message()
    • Metrologically enabled base agents
      • MetrologicalAgent
        • MetrologicalAgent._input_data
        • MetrologicalAgent._output_data
        • MetrologicalAgent.agent_loop()
        • MetrologicalAgent.init_parameters()
        • MetrologicalAgent.on_received_message()
        • MetrologicalAgent.pack_data()
      • MetrologicalMonitorAgent
        • MetrologicalMonitorAgent.init_parameters()
        • MetrologicalMonitorAgent.on_received_message()
        • MetrologicalMonitorAgent.reset()
        • MetrologicalMonitorAgent.update_plot_memory()
    • A metrologically enabled agent to reduce redundancy
      • RedundancyAgent
        • RedundancyAgent.agent_loop()
        • RedundancyAgent.calc_best_est_lin_sys()
        • RedundancyAgent.calc_best_estimate()
        • RedundancyAgent.calc_consistent_estimates_no_corr()
        • RedundancyAgent.calc_lcs()
        • RedundancyAgent.calc_lcss()
        • RedundancyAgent.get_combination()
        • RedundancyAgent.ind_reduce_a()
        • RedundancyAgent.init_lcss_parameters()
        • RedundancyAgent.init_parameters()
        • RedundancyAgent.on_received_message()
        • RedundancyAgent.print_input_lcss()
        • RedundancyAgent.print_output_cbe()
        • RedundancyAgent.print_output_lcs()
        • RedundancyAgent.print_output_lcss()
        • RedundancyAgent.print_output_single()
        • RedundancyAgent.reduce_vx()
    • Metrologically enabled signal agents
      • MetrologicalGeneratorAgent
        • MetrologicalGeneratorAgent.agent_loop()
        • MetrologicalGeneratorAgent.init_parameters()
  • agentMET4FOF streams
    • Base streams
      • DataStreamMET4FOF
        • DataStreamMET4FOF._quantities
        • DataStreamMET4FOF._target
        • DataStreamMET4FOF._time
        • DataStreamMET4FOF._current_sample_quantities
        • DataStreamMET4FOF._current_sample_target
        • DataStreamMET4FOF._current_sample_time
        • DataStreamMET4FOF._sample_idx
        • DataStreamMET4FOF._n_samples
        • DataStreamMET4FOF._data_source_type
        • DataStreamMET4FOF._generator_function
        • DataStreamMET4FOF._generator_parameters
        • DataStreamMET4FOF.sfreq
        • DataStreamMET4FOF._metadata
        • DataStreamMET4FOF._default_generator_function()
        • DataStreamMET4FOF._next_sample_data_source()
        • DataStreamMET4FOF._next_sample_generator()
        • DataStreamMET4FOF._set_data_source_type()
        • DataStreamMET4FOF.all_samples()
        • DataStreamMET4FOF.has_more_samples()
        • DataStreamMET4FOF.next_sample()
        • DataStreamMET4FOF.randomize_data()
        • DataStreamMET4FOF.reset()
        • DataStreamMET4FOF.set_data_source()
        • DataStreamMET4FOF.set_generator_function()
        • DataStreamMET4FOF.set_metadata()
    • Signal streams
      • CosineGenerator
        • CosineGenerator.cosine_wave_function()
      • SineGenerator
        • SineGenerator.sine_wave_function()
      • SineWithJitterGenerator
        • SineWithJitterGenerator._next_sample_generator()
        • SineWithJitterGenerator.jitter_std
      • StaticSineWithJitterGenerator
    • Metrologically enabled base streams
      • MetrologicalDataStreamMET4FOF
        • MetrologicalDataStreamMET4FOF._generator_function_unc
        • MetrologicalDataStreamMET4FOF._uncertainty_parameters
        • MetrologicalDataStreamMET4FOF._default_uncertainty_generator()
        • MetrologicalDataStreamMET4FOF._next_sample_generator()
        • MetrologicalDataStreamMET4FOF.set_generator_function()
        • MetrologicalDataStreamMET4FOF.time_unc
        • MetrologicalDataStreamMET4FOF.value_unc
    • Metrologically enabled signal streams
      • MetrologicalMultiWaveGenerator
      • MetrologicalSineGenerator
        • MetrologicalSineGenerator._sine_wave_function()
  • agentMET4FOF dashboard
    • AgentDashboard
      • AgentDashboard._show_startup_message()
      • AgentDashboard.init_app_layout()
      • AgentDashboard.is_port_at_ip_available()
      • AgentDashboard.run()
    • AgentDashboardProcess
      • AgentDashboardProcess.terminate()
    • AgentDashboardThread
      • AgentDashboardThread.run()
      • AgentDashboardThread.terminate()
  • agentMET4FOF agent network
    • AgentNetwork
      • AgentNetwork.Coalition
      • AgentNetwork.MesaModel
        • AgentNetwork.MesaModel.shutdown()
        • AgentNetwork.MesaModel.step()
      • AgentNetwork._AgentController
        • AgentNetwork._AgentController._get_logger()
        • AgentNetwork._AgentController._transform_string_into_valid_name()
        • AgentNetwork._AgentController.add_coalition()
        • AgentNetwork._AgentController.add_coalition_agent()
        • AgentNetwork._AgentController.agents()
        • AgentNetwork._AgentController.del_coalition()
        • AgentNetwork._AgentController.get_agent()
        • AgentNetwork._AgentController.get_coalition()
        • AgentNetwork._AgentController.init_parameters()
        • AgentNetwork._AgentController.remove_agent_from_coalition()
      • AgentNetwork._Logger
        • AgentNetwork._Logger.init_parameters()
      • AgentNetwork._get_controller()
      • AgentNetwork._get_controller_mode()
      • AgentNetwork._get_logger()
      • AgentNetwork._set_controller_mode()
      • AgentNetwork.add_agent()
      • AgentNetwork.add_coalition()
      • AgentNetwork.add_coalition_agent()
      • AgentNetwork.agents()
      • AgentNetwork.agents_by_type()
      • AgentNetwork.bind_agents()
      • AgentNetwork.connect()
      • AgentNetwork.get_agent()
      • AgentNetwork.get_coalition()
      • AgentNetwork.remove_agent()
      • AgentNetwork.remove_coalition_agent()
      • AgentNetwork.reset_agents()
      • AgentNetwork.set_agents_state()
      • AgentNetwork.set_running_state()
      • AgentNetwork.set_stop_state()
      • AgentNetwork.shutdown()
      • AgentNetwork.start_server_mesa()
      • AgentNetwork.start_server_osbrain()
      • AgentNetwork.unbind_agents()
  • agentMET4FOF utilities
    • Buffering for agents
      • AgentBuffer
        • AgentBuffer.buffer
        • AgentBuffer.buffer_size
        • AgentBuffer.supported_datatypes
        • AgentBuffer._concatenate()
        • AgentBuffer._iterable_filled()
        • AgentBuffer._popleft()
        • AgentBuffer.buffer_filled()
        • AgentBuffer.check_supported_datatype()
        • AgentBuffer.clear()
        • AgentBuffer.items()
        • AgentBuffer.keys()
        • AgentBuffer.popleft()
        • AgentBuffer.store()
        • AgentBuffer.update()
        • AgentBuffer.values()
      • MetrologicalAgentBuffer
        • MetrologicalAgentBuffer._concatenate()
        • MetrologicalAgentBuffer.convert_single_to_tsbuffer()
        • MetrologicalAgentBuffer.update()
  • UML diagrams of agentMET4FOF
    • Overview
    • UML class diagram of agentMET4FOF.agents
    • UML class diagram of agentMET4FOF.streams
    • UML class diagram of agentMET4FOF.metrological_agents
    • UML class diagram of agentMET4FOF.metrological_agents
    • Creation of the UMLs
agentMET4FOF
  • Search

© Copyright 2021, Bang Xiang Yong (UCAM), Björn Ludwig (PTB), Anupam Prasad Vedurmudi (PTB), Maximilian Gruber (PTB), Haris Lulic (IMBIH). Revision 0593d9eb.

Built with Sphinx using a theme provided by Read the Docs.