DISCUSS: What is this repo for? #53
Description
As we move more functionality into mud, I want to have a clear delineation that is communicated in the README about what this repo is for, and which contributions should be in mud vs mud-examples.
One thing that feels "obvious" is that console scripts such as mud_run_all which are defined here should be defined in mud-examples and not mud.
Notebooks can be contributed here, but mud should avoid them entirely. The idea is that a folder full of figures can be generated by simply installing mud-examples and running a console script that it installed. A lot of the mess that accomplishes that will be here, whereas well-tested and well-documented code concerned with core functionality is contributed to mud.