This note is intended to help you navigate around the docs
folder.
It is not quite the normal software document folder because it also contains project-level deliverables. Hence, there is more information than you might expect in this folder, and the information might be in places you do not expect either.
If you are an academic looking to apply the framework, first read quickstart.rst
. For more explanation of the installation process, read installation.rst
. For examples of using the framework read Cookbook.docx. Finally, for an overview of the framework, read Report.docx.
If you are a developer looking to maintain the framework, first read Report.docx for an overview. For more explanation of the design decisions, read design.rst
. For guidance on data suitable for testing, read testing.rst
.
To address the potential breadth of audience for these documents, all .rst
files are available as .html
pages too.
Diagrams are developed in PowerPoint and saved as .pptx files
. Pictures are exported from these files in png format.
The main project report is written in Word. There is a lot of information in Report.docx. Examples of use are in Cookbook.docx.