assume-framework / assume

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

Add new examples: basics, market configuration #233

Closed nick-harder closed 9 months ago

nick-harder commented 12 months ago

We should also add a notebook and documentation examples for basic run, for configuration file and possible market configurations.

maurerle commented 11 months ago

See docs on adding jupyter notebooks to readthedocs:

https://docs.readthedocs.io/en/stable/guides/jupyter.html#including-classic-ipynb-notebooks-in-sphinx-documentation

While making examples think of what needs to be documented and document it accordingly -> 1. API description is correct and 2. and include it if necessary in the descriptions in the read the docs. So with regard to the exhaustive list in #232. The jupyter notebook files in the read_the_docs should be written in a way that assume ASSUME is alredy installed and at the top we have a test in colab button which is basically the same but has the general installation cell and pull github as well.

For each example 4 things need to be done:

  1. do jupyter notebook
  2. convert it into the colab
  3. check if API description of functions or classes is correct (use type hints eg. "forecaster: Optional[Forecaster] = {...}" to indicate that this is optional)
  4. include it if necessary in the descriptions in the read the docs, use google format for strings (you can directly prompt that in ChatGPT ;) ) We make general description of the function at the top and the more detailed one at the end with the label "Notes"
kim-mskw commented 11 months ago

We decided to ditch the double book keeping of having input files for the case studies somehow in the code. We like the jupyter notebook documentation and would like to do that as well for the case studies (currently named examples in the example folder). Like this we can omit the documentation of the case studies and keep it in jupyter notebook.

So To Dos in January:

kim-mskw commented 11 months ago

The exampels in the DOC are now named tutroials

nick-harder commented 9 months ago

close with the latest commits