assume-framework / assume

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

Added the minimal example #257

Closed nick-harder closed 9 months ago

nick-harder commented 9 months ago

-added the first small jupyter example -added it to the documentation -improved docstrings for world class -improved docstrings for forecast class -adjusted the structure of documentation index -adjusted structure of automated docs -small fixes in several other docstings

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (5db9076) 78.44% compared to head (226d6c0) 78.44%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #257 +/- ## ======================================= Coverage 78.44% 78.44% ======================================= Files 39 39 Lines 4259 4259 ======================================= Hits 3341 3341 Misses 918 918 ``` | [Flag](https://app.codecov.io/gh/assume-framework/assume/pull/257/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/257/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | `78.44% <ø> (ø)` | | 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.