Developer Documentation

  1. Developer Documentation
    1. Modular organization
    2. File naming conventions

Modular organization

The image below shows a diagram of WellReader's documentation.

File naming conventions

We decided to name .m functions from the module they belong to, thus you will find:

There are some exceptions though, namely:

Some functions are module-independent or generic, and therefore follow no particular naming convention. This concerns for instance ampmto24.m, substr.m, and some other functions.

We avoided using large nested functions and, when unavoidable, have restricted these to some basic operations. If possible, an M-file has been produced for each function.