Improve CopyMe models documentation and defaults
The following discussion from !134 (merged) should be addressed:
-
@herdeanu started a discussion: (+2 comments) Experiences from building a model with the CopyMeGrid model. Everything up for discussion.
- Should we really have
sync
update as the default update mode? I guess from our experience so far, most people useasync
. The most flexible would be to set it tomanual
. However, I would not like it as default too much because it also has its pitfalls, especially when usingsync
update. Still, I would like to raise the question of whether the default should not be async update with shuffling?🤔 - In the dataset initialization within the model initializer list of the constructor, the
create_cm_dset
function is not explained in the comment, although it would be helpful to have it explained at that location, I guess. - I would propose to add an introductory section with a remark to the ubiquitous comments: Go through the comments and if they are clear and the developer understands and has learned what they mean, remove the obsolete notes! Clean-up is important and so far, at least my impression is that a lot of obsolete comments are still present in models.
- In the synchronous
apply_rule
:// Get the current state of the cell
-->// Get a copy of the current state of the cell
We can discuss them here and, I would propose to directly implement the changes in this MR. Alternatively, create a new MR.
- Should we really have
-
Adjust default RST to include base plots and plot config, see this discussion in !134
Edited by Utopia Developers