agentMET4FOF
v0.8.0
Getting started:
Table of content
💫Quickstart
💬About
📈The agentMET4FOF dashboard
📖Documentation and video tutorials
Video tutorial series
Live online tutorial during early development
💻Installation
💨Coming soon
🖋Citation
💎Acknowledgement
⚠Disclaimer
©License
Installation of agentMET4FOF
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
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
How to 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.6.1 (2021-03-12)
Fix
Documentation
Tutorials:
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
Code Reference:
agentMET4FOF agents
agentMET4FOF streams
agentMET4FOF metrologically enabled agents
agentMET4FOF metrologically enabled streams
agentMET4FOF dashboard
agentMET4FOF
Docs
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
_
_concatenate() (agentMET4FOF.metrological_agents.MetrologicalAgentBuffer method)
_current_sample_quantities (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_current_sample_target (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_current_sample_time (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_data_source_type (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_default_generator_function() (agentMET4FOF.streams.DataStreamMET4FOF method)
_default_uncertainty_generator() (agentMET4FOF.metrological_streams.MetrologicalDataStreamMET4FOF method)
_generator_function (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_generator_function_unc (agentMET4FOF.metrological_streams.MetrologicalDataStreamMET4FOF attribute)
_generator_parameters (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_input_data (agentMET4FOF.metrological_agents.MetrologicalAgent attribute)
_metadata (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_n_samples (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_next_sample_data_source() (agentMET4FOF.streams.DataStreamMET4FOF method)
_next_sample_generator() (agentMET4FOF.metrological_streams.MetrologicalDataStreamMET4FOF method)
(agentMET4FOF.streams.DataStreamMET4FOF method)
_output_data (agentMET4FOF.metrological_agents.MetrologicalAgent attribute)
_quantities (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_sample_idx (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_set_data_source_type() (agentMET4FOF.streams.DataStreamMET4FOF method)
_sine_wave_function() (agentMET4FOF.metrological_streams.MetrologicalSineGenerator method)
_target (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_time (agentMET4FOF.streams.DataStreamMET4FOF attribute)
_uncertainty_parameters (agentMET4FOF.metrological_streams.MetrologicalDataStreamMET4FOF attribute)
A
add_agent() (agentMET4FOF.agents.AgentNetwork method)
add_coalition() (agentMET4FOF.agents.AgentNetwork method)
add_coalition_agent() (agentMET4FOF.agents.AgentNetwork method)
agent_loop() (agentMET4FOF.agents.AgentMET4FOF method)
(agentMET4FOF.agents.DataStreamAgent method)
(agentMET4FOF.agents.SineGeneratorAgent method)
(agentMET4FOF.metrological_agents.MetrologicalAgent method)
(agentMET4FOF.metrological_agents.MetrologicalGeneratorAgent method)
AgentBuffer (class in agentMET4FOF.agents)
AgentDashboard (class in agentMET4FOF.dashboard.Dashboard)
AgentDashboardProcess (class in agentMET4FOF.dashboard.Dashboard)
AgentDashboardThread (class in agentMET4FOF.dashboard.Dashboard)
AgentMET4FOF (class in agentMET4FOF.agents)
agentMET4FOF.agents (module)
agentMET4FOF.dashboard.Dashboard (module)
agentMET4FOF.metrological_agents (module)
agentMET4FOF.metrological_streams (module)
agentMET4FOF.streams (module)
AgentNetwork (class in agentMET4FOF.agents)
agents() (agentMET4FOF.agents.AgentNetwork method)
AgentType (agentMET4FOF.agents.AgentMET4FOF attribute)
all_samples() (agentMET4FOF.streams.DataStreamMET4FOF method)
B
bind_agents() (agentMET4FOF.agents.AgentNetwork method)
bind_output() (agentMET4FOF.agents.AgentMET4FOF method)
buffer (agentMET4FOF.agents.AgentBuffer attribute)
buffer_clear() (agentMET4FOF.agents.AgentMET4FOF method)
buffer_filled() (agentMET4FOF.agents.AgentBuffer method)
(agentMET4FOF.agents.AgentMET4FOF method)
buffer_size (agentMET4FOF.agents.AgentBuffer attribute)
(agentMET4FOF.agents.AgentMET4FOF attribute)
buffer_store() (agentMET4FOF.agents.AgentMET4FOF method)
C
check_supported_datatype() (agentMET4FOF.agents.AgentBuffer method)
clear() (agentMET4FOF.agents.AgentBuffer method)
Coalition (class in agentMET4FOF.agents)
connect() (agentMET4FOF.agents.AgentNetwork method)
convert_single_to_tsbuffer() (agentMET4FOF.metrological_agents.MetrologicalAgentBuffer method)
cosine_wave_function() (agentMET4FOF.streams.CosineGenerator method)
CosineGenerator (class in agentMET4FOF.streams)
current_state (agentMET4FOF.agents.AgentMET4FOF attribute)
custom_plot_function (agentMET4FOF.agents.MonitorAgent attribute)
custom_plot_parameters (agentMET4FOF.agents.MonitorAgent attribute)
D
DataStreamAgent (class in agentMET4FOF.agents)
DataStreamMET4FOF (class in agentMET4FOF.streams)
E
extract_x_y() (in module agentMET4FOF.streams)
G
get_agent() (agentMET4FOF.agents.AgentNetwork method)
get_attr() (agentMET4FOF.agents.AgentMET4FOF method)
get_coalition() (agentMET4FOF.agents.AgentNetwork method)
get_mode() (agentMET4FOF.agents.AgentNetwork method)
H
handle_process_data() (agentMET4FOF.agents.AgentMET4FOF method)
I
init_agent() (agentMET4FOF.agents.AgentMET4FOF method)
init_agent_loop() (agentMET4FOF.agents.AgentMET4FOF method)
init_app_layout() (agentMET4FOF.dashboard.Dashboard.AgentDashboard method)
init_buffer() (agentMET4FOF.agents.AgentMET4FOF method)
init_parameters() (agentMET4FOF.agents.AgentMET4FOF method)
(agentMET4FOF.agents.DataStreamAgent method)
(agentMET4FOF.agents.MonitorAgent method)
(agentMET4FOF.agents.SineGeneratorAgent method)
(agentMET4FOF.metrological_agents.MetrologicalAgent method)
(agentMET4FOF.metrological_agents.MetrologicalGeneratorAgent method)
(agentMET4FOF.metrological_agents.MetrologicalMonitorAgent method)
Inputs (agentMET4FOF.agents.AgentMET4FOF attribute)
is_port_available() (agentMET4FOF.dashboard.Dashboard.AgentDashboard method)
items() (agentMET4FOF.agents.AgentBuffer method)
K
keys() (agentMET4FOF.agents.AgentBuffer method)
L
log_info() (agentMET4FOF.agents.AgentMET4FOF method)
loop_wait (agentMET4FOF.agents.AgentMET4FOF attribute)
M
MesaModel (class in agentMET4FOF.agents)
MetrologicalAgent (class in agentMET4FOF.metrological_agents)
MetrologicalAgentBuffer (class in agentMET4FOF.metrological_agents)
MetrologicalDataStreamMET4FOF (class in agentMET4FOF.metrological_streams)
MetrologicalGeneratorAgent (class in agentMET4FOF.metrological_agents)
MetrologicalMonitorAgent (class in agentMET4FOF.metrological_agents)
MetrologicalMultiWaveGenerator (class in agentMET4FOF.metrological_streams)
MetrologicalSineGenerator (class in agentMET4FOF.metrological_streams)
MonitorAgent (class in agentMET4FOF.agents)
N
next_sample() (agentMET4FOF.streams.DataStreamMET4FOF method)
O
on_connect_output() (agentMET4FOF.agents.AgentMET4FOF method)
on_received_message() (agentMET4FOF.agents.AgentMET4FOF method)
(agentMET4FOF.agents.MonitorAgent method)
(agentMET4FOF.metrological_agents.MetrologicalAgent method)
(agentMET4FOF.metrological_agents.MetrologicalMonitorAgent method)
Outputs (agentMET4FOF.agents.AgentMET4FOF attribute)
P
pack_data() (agentMET4FOF.agents.AgentMET4FOF method)
(agentMET4FOF.metrological_agents.MetrologicalAgent method)
plot_filter (agentMET4FOF.agents.MonitorAgent attribute)
plots (agentMET4FOF.agents.MonitorAgent attribute)
popleft() (agentMET4FOF.agents.AgentBuffer method)
PubAddr (agentMET4FOF.agents.AgentMET4FOF attribute)
PubAddr_alias (agentMET4FOF.agents.AgentMET4FOF attribute)
R
randomize_data() (agentMET4FOF.streams.DataStreamMET4FOF method)
remove_coalition_agent() (agentMET4FOF.agents.AgentNetwork method)
reset() (agentMET4FOF.agents.AgentMET4FOF method)
(agentMET4FOF.agents.DataStreamAgent method)
(agentMET4FOF.agents.MonitorAgent method)
(agentMET4FOF.metrological_agents.MetrologicalMonitorAgent method)
respond_reply_attr_() (agentMET4FOF.agents.AgentMET4FOF method)
respond_request_attr_() (agentMET4FOF.agents.AgentMET4FOF method)
respond_request_method_() (agentMET4FOF.agents.AgentMET4FOF method)
run() (agentMET4FOF.dashboard.Dashboard.AgentDashboard method)
(agentMET4FOF.dashboard.Dashboard.AgentDashboardThread method)
S
send_output() (agentMET4FOF.agents.AgentMET4FOF method)
send_plot() (agentMET4FOF.agents.AgentMET4FOF method)
send_request_attribute() (agentMET4FOF.agents.AgentMET4FOF method)
send_request_method() (agentMET4FOF.agents.AgentMET4FOF method)
send_set_attr() (agentMET4FOF.agents.AgentMET4FOF method)
set_agents_state() (agentMET4FOF.agents.AgentNetwork method)
set_attr() (agentMET4FOF.agents.AgentMET4FOF method)
set_data_source() (agentMET4FOF.streams.DataStreamMET4FOF method)
set_generator_function() (agentMET4FOF.metrological_streams.MetrologicalDataStreamMET4FOF method)
(agentMET4FOF.streams.DataStreamMET4FOF method)
set_metadata() (agentMET4FOF.streams.DataStreamMET4FOF method)
set_running_state() (agentMET4FOF.agents.AgentNetwork method)
set_stop_state() (agentMET4FOF.agents.AgentNetwork method)
sfreq (agentMET4FOF.streams.DataStreamMET4FOF attribute)
shutdown() (agentMET4FOF.agents.AgentMET4FOF method)
(agentMET4FOF.agents.AgentNetwork method)
(agentMET4FOF.agents.MesaModel method)
sine_wave_function() (agentMET4FOF.streams.SineGenerator method)
SineGenerator (class in agentMET4FOF.streams)
SineGeneratorAgent (class in agentMET4FOF.agents)
start_server_mesa() (agentMET4FOF.agents.AgentNetwork method)
start_server_osbrain() (agentMET4FOF.agents.AgentNetwork method)
step() (agentMET4FOF.agents.AgentMET4FOF method)
(agentMET4FOF.agents.MesaModel method)
stop_agent_loop() (agentMET4FOF.agents.AgentMET4FOF method)
store() (agentMET4FOF.agents.AgentBuffer method)
supported_datatypes (agentMET4FOF.agents.AgentBuffer attribute)
T
terminate() (agentMET4FOF.dashboard.Dashboard.AgentDashboardProcess method)
(agentMET4FOF.dashboard.Dashboard.AgentDashboardThread method)
time_unc (agentMET4FOF.metrological_streams.MetrologicalDataStreamMET4FOF attribute)
U
unbind_agents() (agentMET4FOF.agents.AgentNetwork method)
unbind_output() (agentMET4FOF.agents.AgentMET4FOF method)
update() (agentMET4FOF.agents.AgentBuffer method)
(agentMET4FOF.metrological_agents.MetrologicalAgentBuffer method)
update_plot_memory() (agentMET4FOF.agents.MonitorAgent method)
(agentMET4FOF.metrological_agents.MetrologicalMonitorAgent method)
V
value_unc (agentMET4FOF.metrological_streams.MetrologicalDataStreamMET4FOF attribute)
values() (agentMET4FOF.agents.AgentBuffer method)
Read the Docs
v: v0.8.0
Versions
latest
stable
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
improve_docstrings_of_input_data_and_output_data
feature-multiwave_generator
develop
default_metrological_generator_agents
add_changeog_to_docs
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
.