agentMET4FOF
v0.10.2
Getting started:
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
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
Download and import the agentMET4FOF Docker image
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
Get started developing
Orphaned processes
Killing all Python processes in Windows
Killing all Python processes on Mac and Linux
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
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
Changelog
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
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
Working with signals carrying redundant information
Redundancy Agent – Determining redundancy in several similar signals
Redundancy Agent – Determining redundancy in one single signal
Code Reference:
agentMET4FOF agents
Base agents
Signal agents
Metrologically enabled base agents
Metrological agents to reduce redundancy
Metrologically enabled signal agents
agentMET4FOF streams
Base streams
Signal streams
Metrologically enabled base streams
Metrologically enabled signal streams
agentMET4FOF dashboard
agentMET4FOF agent network
agentMET4FOF utilities
Buffering for agents
agentMET4FOF
Docs
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
_
_bind_output() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
_concatenate() (agentMET4FOF.utils.buffer.AgentBuffer method)
(agentMET4FOF.utils.buffer.MetrologicalAgentBuffer method)
_convert_matplotlib_fig() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
_convert_to_plotly() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
_current_sample_quantities (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_current_sample_target (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_current_sample_time (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_data_source_type (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_default_generator_function() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
_default_uncertainty_generator() (agentMET4FOF.streams.metrological_base_streams.MetrologicalDataStreamMET4FOF method)
_fig_to_uri() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
_generator_function (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_generator_function_unc (agentMET4FOF.streams.metrological_base_streams.MetrologicalDataStreamMET4FOF attribute)
_generator_parameters (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_get_controller() (agentMET4FOF.network.AgentNetwork method)
_get_logger() (agentMET4FOF.network.AgentNetwork method)
(agentMET4FOF.network.AgentNetwork._AgentController method)
_get_metadata() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
_get_mode() (agentMET4FOF.network.AgentNetwork method)
_input_data (agentMET4FOF.agents.metrological_base_agents.MetrologicalAgent attribute)
_is_type_message() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
_iterable_filled() (agentMET4FOF.utils.buffer.AgentBuffer method)
_metadata (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_n_samples (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_next_sample_data_source() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
_next_sample_generator() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
(agentMET4FOF.streams.metrological_base_streams.MetrologicalDataStreamMET4FOF method)
_output_data (agentMET4FOF.agents.metrological_base_agents.MetrologicalAgent attribute)
_popleft() (agentMET4FOF.utils.buffer.AgentBuffer static method)
_quantities (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_remove_methods() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
_sample_idx (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_set_data_source_type() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
_set_mode() (agentMET4FOF.network.AgentNetwork method)
_show_startup_message() (agentMET4FOF.dashboard.Dashboard.AgentDashboard method)
_sine_wave_function() (agentMET4FOF.streams.metrological_signal_streams.MetrologicalSineGenerator method)
_target (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_time (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
_uncertainty_parameters (agentMET4FOF.streams.metrological_base_streams.MetrologicalDataStreamMET4FOF attribute)
_update_output_channels_info() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
A
add_agent() (agentMET4FOF.network.AgentNetwork method)
add_coalition() (agentMET4FOF.network.AgentNetwork method)
(agentMET4FOF.network.AgentNetwork._AgentController method)
add_coalition_agent() (agentMET4FOF.network.AgentNetwork method)
(agentMET4FOF.network.AgentNetwork._AgentController method)
agent_loop() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.agents.base_agents.DataStreamAgent method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalAgent method)
(agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
(agentMET4FOF.agents.metrological_signal_agents.MetrologicalGeneratorAgent method)
(agentMET4FOF.agents.signal_agents.SineGeneratorAgent method)
AgentBuffer (class in agentMET4FOF.utils.buffer)
AgentDashboard (class in agentMET4FOF.dashboard.Dashboard)
AgentDashboardProcess (class in agentMET4FOF.dashboard.Dashboard)
AgentDashboardThread (class in agentMET4FOF.dashboard.Dashboard)
AgentMET4FOF (class in agentMET4FOF.agents.base_agents)
agentMET4FOF.agents.base_agents (module)
agentMET4FOF.agents.metrological_base_agents (module)
agentMET4FOF.agents.metrological_redundancy_agents (module)
agentMET4FOF.agents.metrological_signal_agents (module)
agentMET4FOF.agents.signal_agents (module)
agentMET4FOF.dashboard.Dashboard (module)
agentMET4FOF.network (module)
agentMET4FOF.streams.base_streams (module)
agentMET4FOF.streams.metrological_base_streams (module)
agentMET4FOF.streams.metrological_signal_streams (module)
agentMET4FOF.streams.signal_streams (module)
agentMET4FOF.utils.buffer (module)
AgentNetwork (class in agentMET4FOF.network)
AgentNetwork._AgentController (class in agentMET4FOF.network)
AgentNetwork._Logger (class in agentMET4FOF.network)
AgentNetwork.Coalition (class in agentMET4FOF.network)
AgentNetwork.MesaModel (class in agentMET4FOF.network)
agents() (agentMET4FOF.network.AgentNetwork method)
AgentType (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
all_samples() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
B
bind_agents() (agentMET4FOF.network.AgentNetwork method)
bind_output() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
buffer (agentMET4FOF.utils.buffer.AgentBuffer attribute)
buffer_clear() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
buffer_filled() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.utils.buffer.AgentBuffer method)
buffer_size (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
(agentMET4FOF.utils.buffer.AgentBuffer attribute)
buffer_store() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
C
calc_best_est_lin_sys() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
calc_best_estimate() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
calc_consistent_estimates_no_corr() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
calc_lcs() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
calc_lcss() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
check_supported_datatype() (agentMET4FOF.utils.buffer.AgentBuffer method)
clear() (agentMET4FOF.utils.buffer.AgentBuffer method)
connect() (agentMET4FOF.network.AgentNetwork method)
convert_single_to_tsbuffer() (agentMET4FOF.utils.buffer.MetrologicalAgentBuffer method)
cosine_wave_function() (agentMET4FOF.streams.signal_streams.CosineGenerator method)
CosineGenerator (class in agentMET4FOF.streams.signal_streams)
current_state (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
custom_plot_function (agentMET4FOF.agents.base_agents.MonitorAgent attribute)
custom_plot_parameters (agentMET4FOF.agents.base_agents.MonitorAgent attribute)
D
DataStreamAgent (class in agentMET4FOF.agents.base_agents)
DataStreamMET4FOF (class in agentMET4FOF.streams.base_streams)
G
get_agent() (agentMET4FOF.network.AgentNetwork method)
get_attr() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
get_coalition() (agentMET4FOF.network.AgentNetwork method)
(agentMET4FOF.network.AgentNetwork._AgentController method)
get_combination() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
get_mode() (agentMET4FOF.network.AgentNetwork method)
H
handle_process_data() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
I
ind_reduce_a() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
init_agent() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
init_agent_loop() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
init_app_layout() (agentMET4FOF.dashboard.Dashboard.AgentDashboard method)
init_buffer() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
init_lcss_parameters() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
init_parameters() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.agents.base_agents.DataStreamAgent method)
(agentMET4FOF.agents.base_agents.MonitorAgent method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalAgent method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalMonitorAgent method)
(agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
(agentMET4FOF.agents.metrological_signal_agents.MetrologicalGeneratorAgent method)
(agentMET4FOF.agents.signal_agents.SineGeneratorAgent method)
(agentMET4FOF.network.AgentNetwork._AgentController method)
(agentMET4FOF.network.AgentNetwork._Logger method)
Inputs (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
is_port_available() (agentMET4FOF.dashboard.Dashboard.AgentDashboard method)
items() (agentMET4FOF.utils.buffer.AgentBuffer method)
K
keys() (agentMET4FOF.utils.buffer.AgentBuffer method)
L
log_info() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
loop_wait (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
M
MetrologicalAgent (class in agentMET4FOF.agents.metrological_base_agents)
MetrologicalAgentBuffer (class in agentMET4FOF.utils.buffer)
MetrologicalDataStreamMET4FOF (class in agentMET4FOF.streams.metrological_base_streams)
MetrologicalGeneratorAgent (class in agentMET4FOF.agents.metrological_signal_agents)
MetrologicalMonitorAgent (class in agentMET4FOF.agents.metrological_base_agents)
MetrologicalMultiWaveGenerator (class in agentMET4FOF.streams.metrological_signal_streams)
MetrologicalSineGenerator (class in agentMET4FOF.streams.metrological_signal_streams)
MonitorAgent (class in agentMET4FOF.agents.base_agents)
N
next_sample() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
O
on_connect_output() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
on_received_message() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.agents.base_agents.MonitorAgent method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalAgent method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalMonitorAgent method)
(agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
Outputs (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
P
pack_data() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalAgent method)
plot_filter (agentMET4FOF.agents.base_agents.MonitorAgent attribute)
plots (agentMET4FOF.agents.base_agents.MonitorAgent attribute)
popleft() (agentMET4FOF.utils.buffer.AgentBuffer method)
print_input_lcss() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
print_output_cbe() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent method)
print_output_lcs() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
print_output_lcss() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
print_output_single() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
PubAddr (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
PubAddr_alias (agentMET4FOF.agents.base_agents.AgentMET4FOF attribute)
R
randomize_data() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
reduce_vx() (agentMET4FOF.agents.metrological_redundancy_agents.RedundancyAgent static method)
RedundancyAgent (class in agentMET4FOF.agents.metrological_redundancy_agents)
remove_coalition_agent() (agentMET4FOF.network.AgentNetwork method)
(agentMET4FOF.network.AgentNetwork._AgentController method)
reset() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.agents.base_agents.DataStreamAgent method)
(agentMET4FOF.agents.base_agents.MonitorAgent method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalMonitorAgent method)
respond_reply_attr_() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
respond_request_attr_() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
respond_request_method_() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
run() (agentMET4FOF.dashboard.Dashboard.AgentDashboard method)
(agentMET4FOF.dashboard.Dashboard.AgentDashboardThread method)
S
send_output() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
send_plot() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
send_request_attribute() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
send_request_method() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
send_set_attr() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
set_agents_state() (agentMET4FOF.network.AgentNetwork method)
set_attr() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
set_data_source() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
set_generator_function() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
(agentMET4FOF.streams.metrological_base_streams.MetrologicalDataStreamMET4FOF method)
set_metadata() (agentMET4FOF.streams.base_streams.DataStreamMET4FOF method)
set_running_state() (agentMET4FOF.network.AgentNetwork method)
set_stop_state() (agentMET4FOF.network.AgentNetwork method)
sfreq (agentMET4FOF.streams.base_streams.DataStreamMET4FOF attribute)
shutdown() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.network.AgentNetwork method)
(agentMET4FOF.network.AgentNetwork.MesaModel method)
sine_wave_function() (agentMET4FOF.streams.signal_streams.SineGenerator method)
SineGenerator (class in agentMET4FOF.streams.signal_streams)
SineGeneratorAgent (class in agentMET4FOF.agents.signal_agents)
start_server_mesa() (agentMET4FOF.network.AgentNetwork method)
start_server_osbrain() (agentMET4FOF.network.AgentNetwork method)
step() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
(agentMET4FOF.network.AgentNetwork.MesaModel method)
stop_agent_loop() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
store() (agentMET4FOF.utils.buffer.AgentBuffer method)
supported_datatypes (agentMET4FOF.utils.buffer.AgentBuffer attribute)
T
terminate() (agentMET4FOF.dashboard.Dashboard.AgentDashboardProcess method)
(agentMET4FOF.dashboard.Dashboard.AgentDashboardThread method)
time_unc (agentMET4FOF.streams.metrological_base_streams.MetrologicalDataStreamMET4FOF attribute)
U
unbind_agents() (agentMET4FOF.network.AgentNetwork method)
unbind_output() (agentMET4FOF.agents.base_agents.AgentMET4FOF method)
update() (agentMET4FOF.utils.buffer.AgentBuffer method)
(agentMET4FOF.utils.buffer.MetrologicalAgentBuffer method)
update_plot_memory() (agentMET4FOF.agents.base_agents.MonitorAgent method)
(agentMET4FOF.agents.metrological_base_agents.MetrologicalMonitorAgent method)
V
value_unc (agentMET4FOF.streams.metrological_base_streams.MetrologicalDataStreamMET4FOF attribute)
values() (agentMET4FOF.utils.buffer.AgentBuffer method)
Read the Docs
v: v0.10.2
Versions
latest
stable
v0.10.2
v0.10.1
v0.10.0
v0.9.0
v0.8.1
v0.8.0
v0.7.0
v0.6.4
v0.6.3
v0.6.2
v0.6.1
0.6.0
0.5.2
0.5.1
0.5.0
0.4.1
0.4.0
0.3.0
0.2.2
0.2.1
0.2.0
0.1.11
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
dockerize_agents
develop
add-code-of-conduct-1
0.1.0
0.0.3
0.0.2
0.0.1
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.