SineGeneratorAgent provided, properly shutdown networks and new docs

Changes in version 0.5.0 of agentMET4FOF

BREAKING CHANGE

• almost all attributes of agentMET4FOF.streams now have a leading _ in their name, to emphasize their character of being private

Features

• when calling shutdown() on an agent network with either of the two backends, the execution now stops cleanly
• SineGeneratorAgent is new part of the application code and thus can be integrated by from agentMET4FOF.agents import SineGeneratorAgent (see shortend tutorial 2

Documentation

• (almost) complete rewrite of README.md
• new tutorial on generation of custom signals
• improvement of agentMet4fof.readthedocs.io with
  • more tutorials
  • UML diagrams
  • installation guide
  • contributing guide
  • module reference for metrological streams
  • rewrite of many parts of the streams module's documentation

Allow for proper network shutdown of both backends and enhance test suite

Changes in version 0.4.1 of agentMET4FOF

Fixes

• the shutdown of an agent network running with the Mesa backend raised an exception previously which is resolved by this patch release

Improve test suite

• we now test the proper creation and shutdown of osBrain networks
• we improved the test for proper removal of agents from an agent network

Enhance metrological streams and software testing

Changes in version 0.4.0 of agentMET4FOF

Enhancements of the metrological capabilities

• introduce uncertainties and enhance metrological data streams with proper generation and treatment of uncertainties and metadata specifically in plots
• adapt tutorial 4 to reflect the treatment of uncertainties in metrological streams

Infrastructural improvements

• improve CI pipeline and properly test in conda and venv environments as well as after installing via pip install -e .
• fix Python version to currently 3.8 regarding the requirements files and environment.yml to simplify instructions and dependency pinning

Axis of plots in the dashboard now are labeld based on metadata

0.3.0

Bumb version to 0.3.0

Fix initial bugs in metrological agents

Merge pull request #120 from bangxiangyong/add_backend_mesa

Implement backend of mesa package

Metrological agents officially released

0.2.0

Pin matplotlib to something below 3.3.0 really in setup.py as well

First introduction of metrologically enables agents

In this developmental release we first introduce the module metrological_agents with some new classes and the according docs and another tutorial.

You can install this version via

$ pip install agentMET4FOF==0.2.0.dev1

Strip dependencies

After extracting a couple of tutorials, try outs and examples, we now finally managed to drop some of the heavy dependencies, causing some trouble during some installation routines.

We adapted setup.py, requirements.txt and thus enviroment.yml accordingly.

Important fix of import order

This release does not affect the agent's functionality in general. An error is fixed regarding the imports on some platforms.

Fix

• fix import errors in agentMET4FOF.agents for some platforms

Minor changes to import mechanisms and README

This release does not affect the agent's functionality in general. It just fixes an issue in some Python versions on some platforms and updates the installation process in the README.md

Docs

• remove unneeded NumPy installation from the according section in_README.md_ (b04ddc0)

Fix

• streamline imports in agentMET4FOF.agents (6aac1d6)