Changelog

v0.13.3 (2024-05-15)

Fix

  • base_agents: Fix Mesa model instantiation after upstream change (3f25f43)

Refactor

  • base_agents: Blacken (8fa0baf)

  • base_agents: Change type checks to isinstance() (f9d3f3b)

  • INSTALL.md: Correct typo (70c03b9)

  • simple_generator: Correct some wrong left over text (75d7980)

  • simple_generator: Rename tutorial for plotting a self-made signal (caf6605)

  • UMLs: Exchange UML URLs by GitHub raw URLs (0d81603)

  • base_agents: Introduce citation into class docstring for AgentMET4FOF (5b31f52)

Documentation

  • init_agent: Fix misleading comment in docstring about calling sequence (6eeb0fa)

  • Python version: Clarify that default is Python 3.11 (dcd54ea)

  • tutorials: Introduce simple_generator tutorial into docs (dd838a2)

See all commits in this version

v0.13.2 (2022-02-03)

Fix

  • #266: Correct Mesa agents’ names if only one space (263b07a)

Refactor

  • Backend: Switch to Backend enums to avoid errors with wrong initialization (08f769c)

See all commits in this version

v0.13.1 (2022-02-01)

Fix

  • tutorial2: Repair math agent in tutorial 2 (8cdc12e)

Refactor

  • signal_streams: Turn wave methods into static methods in SineGenerator and CosineGenerator (9d24259)

  • signal_streams: Remove unneeded parenthesis in SineGenerator and CosineGenerator (dce0d86)

See all commits in this version

v0.13.0 (2021-11-12)

Feature

  • Docker: Transfer image to Docker Hub for more convenient usage (14aff5f)

Documentation

  • Docker: Update documentation to reflect new image location (753f461)

See all commits in this version

v0.12.1 (2021-08-27)

Fix

  • DataStreamAgent: Insert missing legacy import for agents.DataStreamAgent (302f61a)

See all commits in this version

v0.12.0 (2021-07-30)

Feature

  • NoiseJitterRemovalAgent: Introduce an agent to reduce the amount of noise and jitter in streamed sensor values (4349548)

  • SineWithJitter: Introduce a streaming data stream of a sine signal with jitter and the corresponding agent (b6ca636)

Refactor

  • Dashboard: Rename Dashboard.is_port_available to Dashboard.is_port_at_ip_available (25a9700)

Documentation

  • README: Introduce link and note about noise and jitter removal tutorial (59cc55e)

  • signal_streams: Improve docstrings and type hints (a7e0007)

See all commits in this version

v0.11.0 (2021-07-29)

Feature

  • Plots: Adapt dashboard such that all agents of types MonitorAgent and MetrologicalMonitorAgent get plotted regardless of their name (67a2544)

  • network: Introduce a method agents_by_type to query for agents of a given type (e43a5b9)

Fix

  • Allow spaces in agents’ names which get replaced by underscores for the osBrain backend (2d8437d)

Refactor

  • AgentNetwork: Change some of the internal variable (06c9a36)

  • SineGeneratorAgent: Improve data sending by including actually computed time (87c3e34)

  • signal_agents: Introduce “official” _sine_stream instance variable for SineGeneratorAgent (98d0f19)

  • signal_agents: Reintroduce NoiseAgent placeholder after module refactorization (f97f4d9)

Documentation

  • network: Introduce some more type hints (ee4b158)

See all commits in this version

v0.10.1 (2021-07-23)

Fix

  • CODE_OF_CONDUCT: Finally add a code of conduct (56ee503)

Refactor

  • CONTRIBUTING: Change heading and location of CONTRIBUTING.md to make it more visible (1ff173f)

Documentation

  • README: Introduce key facts (0e2d936)

  • README: Introduce Tutorials section (e1f41e9)

  • README: Introduce Contributing section (85e8d9f)

See all commits in this version

v0.10.0 (2021-07-21)

Feature

  • Docker: Create container image for every release (1a40eaf)

Refactor

  • network: Change delivery ip to 0.0.0.0, i.e. all interfaces instead of 127.0.0.1 to enable docker deployment (2472826)

Documentation

  • ReadTheDocs: Include Docker guide (7c35bba)

  • CONTRIBUTING: Mention commit type refactor in contributing guide (a4891e7)

  • metrological_redundancy_agents: Introduce redundancy agent into docs (cb493cb)

See all commits in this version

v0.9.0 (2021-07-08)

Feature

  • agents: Adds ampl and phase_ini parameters to SineGeneratorAgent (774a91b)

  • streams: Adds ampl and phase_ini parameters to SineGenerator and CosineGenerator (998b158)

  • metrological_streams: Adds ampl and phase_ini parameters to MetrologicalSineGenerator (fc9901e)

  • redundancy agent: Adds redundancy agent class to metrological_agents.py (7fbe934)

  • MetrologicalGeneratorAgent: Add an agent to handle generic metrological data streams (3334762)

  • MET4FoF redundancy: Method init_parameters1 removed. removed unnecessary comments (afe47c3)

  • MET4FoF redundancy: Second redundancy tutorial integrated (c527f33)

  • MET4FoF redundancy: Tutorial 7 added (caa62ca)

  • MET4FoF redundancy: Met4fof redundancy modules added (bb3cb6a)

  • multiwave: Added multiwave generator to metrological_streams.py (7b0bf4e)

  • multiwave: Added multiwave generator to metrological_streams.py (035d7c9)

Fix

  • tutorial 3: Replace one of the generator agents’ streams by the cosine stream (2f20183)

  • metrological_agents: AgentBuffer import was accidentally removed (cbec978)

Refactor

  • agents and metrological_streams and streams: Renames ‘ampl’ to ‘amplitude’ and ‘phase_ini’ to ‘initial_phase’ (d0d8271)

  • metrological_agents: Refactor metrological_agents.py into a package metrological_agents and include classes into agents (5558008)

  • metrological_streams: Refactor metrological_streams.py into a package metrological_streams and include classes into streams (9da3744)

  • base_streams: Refactor base_streams.py by applying black (34ff2d0)

  • signal_streams: Introduce all variable into signal_streams.py (8c62972)

  • signal_streams: Refactor signal_streams.py by applying black (e604418)

  • streams: Refactor streams.py into a package streams with the modules base_streams and signal_streams (11368ee)

  • signal_agents: Introduce all variable into signal_agents.py (364702f)

  • signal_agents: Refactor signal_agents.py by applying black (396a95e)

  • base_agents: Introduce all variable into base_agents.py (34f626b)

  • base_agents: Refactor base_agents.py by applying black and shortening line lengths (8173324)

  • agents: Refactor agents.py into a package agents with the modules base_agents and signal_agents (c7bdfae)

  • multi_generator: Replaces amplitude with value in variable names in generator classes (ee45e1c)

  • simple_generator: Replaces amplitude with value in variable names in generator classes (f7475ba)

  • metrological agents and streams: Make imports relative (907cdb2)

  • streams: Replaces amplitude with value in variable names in generator classes (177b231)

  • metrological_streams: Replaces amplitude with value in variable names (b4a0118)

  • metrological_streams: Reorder parameters (b0c465f)

  • MetrologicalDataStreamMet4FoF: Refine MetrologicalDataStreamMet4FoF docstring (1bfc2a6)

Documentation

  • ReadTheDocs: Adapt documentation to new package and module structure (ab207c4)

  • tutorial 3: Update fixed notebook with most recent output (5511079)

  • CONTRIBUTING: Change commit log examples to develop’s commits (9ee020f)

  • CHANGELOG: Insert actually current changelog into docs (aff2f6a)

See all commits in this version

v0.8.1 (2021-06-10)

See all commits in this version

v0.8.0 (2021-06-10)

Feature

  • MetrologicalGeneratorAgent: Rewrote to default metrological generator agent for both streams (52606d7)

  • SineGeneratorAgent: Added default sine generator agent to metrological_agents.py (54f4035)

  • multiwave_generator: Multiwave generator added to metrological_streams.py (682a5ff)

Documentation

  • tutorial_7: Introduce tutorial 7 into ReadTheDocs (01d7e44)

  • tutorial_default_generator: Add a tutorial for a generic metrologically enabled agent (7bebef1)

See all commits in this version

v0.7.0 (2021-06-04)

Feature

  • enhance_ui: Button to export agent network display as png (3b41610)

  • enhance_subscribe: Allow special channels for requests (a88a817)

Fix

  • enhance_UI: Fix bug on callback of agents-network.generateImage (d9125ab)

  • enhance_UI: Fix importing name for UI example (58b990b)

  • enhance_ui: Required import visdcc (f02429e)

  • enhance_subscribe: Specify the plot channel for tests (1d293e7)

Documentation

  • enhance_UI: Refactor agent_type to agent_name_filter (a6f8da9)

  • enhance_UI: Add docstring for create_edges_cytoscape method (b66fcb3)

  • enhance_UI: Intuitive name for toast message function in UI (c155138)

  • enhance_UI: Rename and add description to UI example (3a03428)

  • enhance_UI: Refactor tutorial folder on UI example (360f6da)

See all commits in this version

v0.6.4 (2021-05-06)

Fix

  • streams: Remove unnecessary instantiation of sine_freq in method sine_wave_function (192a6c9)

See all commits in this version

v0.6.3 (2021-04-28)

Fix

  • time_series_buffer: Resolve storing nan values (bbc1ae9)

Documentation

  • metrological_agents: Reformat two of our docstrings to properly display thos example values in the docs (c56cca9)

  • metrological_agents: Correct docstrings for _concatenate() (eb6a20b)

See all commits in this version

v0.6.2 (2021-03-19)

Fix

  • dashboard: Finally resolve #186 by cleanly shutting down dashboard (9903d15)

Documentation

  • CHANGELOG: Include CHANGELOG into docs (4ba20d3)

See all commits in this version

v0.6.1 (2021-03-12)

Fix

  • metrological_streams: Fixed computational error for batches of size more than one (686bad5)

  • agents: Fixed buffer.clear method, which did not work anymore after moving from memory to buffer

Documentation

  • README: Include the Zenodo DOI banner and add the Citation section (4a57dd8)

  • docstrings: Seriously improve docstrings and type hinting in agents.py and dashboard/LayoutHelper.py

See all commits in this version