Module Interface Specification

[smiths]

To understand the design we want to divide the system into modules (documented in the module guide #28) and we want to sketch out the interface for each module.

I have a template MIS, but I think this is too much work to begin with. All we need for each module is the following:

• the type of module (record, library, abstract object, abstract data type, generic) (most of your modules will likely be abstract data types)
• the list of access programs
• the list state variables (sometimes this list is empty)
• the list of environment variables (often empty, except for modules for input and output)
• if the purpose of an access program won't be obvious from the name, a brief natural language description will help

We can follow the MIS Format I used in SE 2AA4.

Examples can be found in the SE 2AA4 notes for A2 and A3 each year. For instance, the chemistry example.

Another examples is the MIS for the solar water heating system and for the slope stability analysis program.

[EmilSoleymani]

First version of our MIS added in #59