meltingpot icon indicating copy to clipboard operation
meltingpot copied to clipboard

Request: tutorial for basic functions

Open akhimoche opened this issue 4 months ago • 2 comments

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.

akhimoche avatar Oct 09 '24 16:10 akhimoche