search

assume-framework / assume

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution
https://assume.readthedocs.io
20 stars 5 forks source link

Improve output metrics and do not wait to write output in simulation #341

Closed maurerle closed 2 months ago

maurerle commented 2 months ago

This makes it possible to define additional output queries which are calculated as KPIs at the end of the simulation.

Additionally, we do not wait for the writing of the data in the output container in our simulation anymore. This speeds up the simulation a little bit if the latest mango-agents-assume version is installed

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 82.22222% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 77.57%. Comparing base (dc82544) to head (8af40b3).

Files Patch % Lines
assume/common/outputs.py 81.39% 8 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #341 +/- ## ========================================== + Coverage 77.51% 77.57% +0.06% ========================================== Files 43 43 Lines 5056 5075 +19 ========================================== + Hits 3919 3937 +18 - Misses 1137 1138 +1 ``` | [Flag](https://app.codecov.io/gh/assume-framework/assume/pull/341/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | Coverage Δ | | |---|---|---| | [pytest](https://app.codecov.io/gh/assume-framework/assume/pull/341/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | `77.57% <82.22%> (+0.06%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

maurerle commented 2 months ago

Its not a hard requirement and the latest version is installed by default. Old environments will just not have this until someone executes pip install -U mango-agents-assume or reinstalls in a fresh environment.

So due to backward compatibility I would not bump the dependency :shrug: but good that we thought about it. It will just have the previous behavior if the lib is not updated.