Request: tutorial for basic functions

[akhimoche]

Hi there,

I'm trying to build a substrate ('clean_up') but the documentation, in my opinion, is not very clear about what the functions or their arguments are specifically. For instance, 'roles' in clean_up is only shown to be a sequence of strings, not what those strings should be. If this information is located somewhere in the document or in dmlab2d, it is not easy to find. For ease of usage, I think some worked examples of building the substrates in Python and showcase the differences in usage would be very beneficial.

[jzleibo]

clean_up has no roles. Check out a a substrate like predator_prey to see how to use roles.

[akhimoche]

I'll have a look, thanks! My point is generally that functions like build, get_config etc should be directly explained rather than having to comb through each file to see what they do.