CODE CLINIC MEOM 10/04 - Documentation

[Amine-ouhechou]

Documentation

• Vignette(s) / Example usage: demonstrating major functionality (ideally to solve real-world analysis problems).
• Function Documentation: for functions used in the examples.

[cdurand95]

• Vignette(s) / Example usage: One example is present in the documentation. There could be more description of the variables—typically the area, path, and structure of the data used—so that a complete beginner in satellites could understand what each line is useful for.
• Function Documentation: every function is thoroughly documented, with description of the inputs/outputs and function.

Side comment:

• in description section: what is Zcollections (is it a standard name in satellite data, otherwise you could detailed it)
• Maybe the installation could benefits from requirements.