search

assume-framework / assume

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

Documentation of Unit example #262

Closed Manish-Khanra closed 7 months ago

Manish-Khanra commented 8 months ago

Documentation of an electrlyser unit example

codecov[bot] commented 8 months ago

Codecov Report

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

Comparison is base (f5471f5) 81.90% compared to head (839b77f) 81.90%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #262 +/- ## ======================================= Coverage 81.90% 81.90% ======================================= Files 38 38 Lines 4161 4162 +1 ======================================= + Hits 3408 3409 +1 Misses 753 753 ``` | [Flag](https://app.codecov.io/gh/assume-framework/assume/pull/262/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/262/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | `81.90% <100.00%> (+<0.01%)` | :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.

nick-harder commented 7 months ago

@kim-mskw could you please check this commit please? You have a good eye for details and consistency :-)

nick-harder commented 7 months ago

@Manish-Khanra the part of adding the new unit type is missing. Also, you need something like %%add_to RLStrategy from tutorial 4 RL to be able to have functions inside classes up and running. Please add it where needed. Also, at the beginning, the part about docker and limitations is repeated twice. Please check

nick-harder commented 7 months ago

The tutorial in #266 is supposed to be number 5 - the market comparison tutorial is supposed to stay number 6 - I think.

@maurerle it was decided to merge unit and strategy, so it is 3, RL is 4 and market is 5

nick-harder commented 7 months ago

yes true, I changed the way how it is displayed, is ugly, but this is the only way how it works for docs, but also in collab and locally