[tutorial] add basic example of EOM and LTM comparison #265
Conversation
maurerle
changed the title
maurerle
force-pushed
the
market_paper_tutorial
branch
from
acddfd2
to
8a4ec6e
Compare
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #265 +/- ##
==========================================
+ Coverage 80.22% 81.92% +1.70%
==========================================
Files 38 38
Lines 4136 4156 +20
==========================================
+ Hits 3318 3405 +87
+ Misses 818 751 -67
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
maurerle
force-pushed
the
market_paper_tutorial
branch
from
f34637d
to
1520970
Compare
maurerle
force-pushed
the
market_paper_tutorial
branch
from
1520970
to
007cdcd
Compare
maurerle
force-pushed
the
market_paper_tutorial
branch
from
007cdcd
to
91169ab
Compare
| "source": [ | ||
| "# 5. market comparison tutorial\n", | ||
| "\n", | ||
| "This tutorial describes a showcase [from the scientific paper \"Market Abstraction of Energy Markets and Policies - Application in an Agent-Based Modeling Toolbox\"](https://link.springer.com/chapter/10.1007/978-3-031-48652-4_10).\n", |
There was a problem hiding this comment.
Ideally I would expect people to take a look at the work, but we cannot expect that from everyone? Could you please provide a small theoretical part here, maybe directcly from the paper, introducing the research question and exactly what markets are investigated here?
There was a problem hiding this comment.
I would say the necessity for this depends on the aim of tutorial. Similar to the new name that you @nick-harder suggested. Is it to show the efects of long-term markets and hence get a different angle on the paper results or to showcase how markets can be configured?
If it is the later, I would not include any theory besides a description of the markets and how this description is translated to the market-config.
There was a problem hiding this comment.
we could have both. What if we asked the following RQ? Here is the questions, and we will investigate these market configs. How do we put this into ASSUME? and thus the tutorial.
- fix mermaid charts in docs - fix typos - rename example - fix case sensitive file names for 04_reinforcement_learning_example - clarify 06_market_comparison example instructions
maurerle
force-pushed
the
market_paper_tutorial
branch
2 times, most recently
from
f1bdc70
to
907efd1
Compare
maurerle
force-pushed
the
market_paper_tutorial
branch
from
907efd1
to
93a9468
Compare
| @@ -22,4 +22,4 @@ dependencies: | |||
| - sphinx-book-theme | |||
| - nbsphinx | |||
| - nbsphinx_link | |||
| - sphinxcontrib-mermaid | |||
| - git+https://github.com/maurerle/sphinxcontrib-mermaid@maurerle | |||
There was a problem hiding this comment.
why do we need to rely on this custom version?
There was a problem hiding this comment.
The initialization of mermaid js is currently broken on the upstream version - see here:
#272
This still awaits proper renaming of the examples to tutorials, but can be merged once I tested everything.