search

SciCompMod / memilio

Modular spatio-temporal models for epidemic and pandemic simulations
https://scicompmod.github.io/memilio/
Apache License 2.0
52 stars 15 forks source link

ABM Documentation #390

Open xsaschako opened 1 year ago

xsaschako commented 1 year ago

Create an ABM Documentation.

As heavily requested, we need to make a Documentation for the MEmilio project and one part of it is the ABM-Documentation.

It should: — An overview of the general setup and program workflow. — Detailed information over each class and what it does. Especially which responsibility each class has. — This should also include referenced to parameters / data that is used.

mknaranja commented 1 year ago

@DavidKerkmann @xsaschako Carlotta will partially take over this issue and rework all our doxygen style code comments. I know that you started/wanted to start some off-the-code documentation. What is the status and can you share that with her maybe?

mknaranja commented 1 year ago

@charlie0614 One remark: I just saw the comment "Simulates a Corona test". I think everything should be documented written without specification as much as our models allow for general use. So here I would write "Simulates a test for a specific virus or pathogen considered in the Model".

xsaschako commented 1 year ago

I added @charlie0614 to our github.