LAPCAP Library

The below sets out the full set of documentation for LAPCAP, alongside where it can be found. In some cases, it may be stored in multiple locations and care should be taken to ensure both copies remain up to date.

In general, documentation should be kept as close to the code as possible, for ease of access. However, this may not always be possible.

Overarching Documentation

	Description	Location
Model Development Plan	A plan for model development, quality assurance and signoff processes.	LAPCAP Model Development Plan
Signoff Log	Log of signoffs obtained for each version of LAPCAP.	03 LAPCAP Signoff Log
FPC Team Pages	Detailed practical steps required for various team processes. Model development plan is stored here also.	FPC Team Pages

There are also templates for:

• Assumptions logs (TEMPLATE modulename assumptions_log.xlsm)
• Change logs (TEMPLATE model output sensitivity testing.xlsx)
  • Used to check changes in outputs for each merge.
• Verification logs (TEMPLATE verification log.xlsx)
  • Used by our quality assurance lead (Peter Neary) to keep a record of verification being done for each merge.

Version Specific Documentation

In the 00 Model Master folder, each model version will have a folder. This will contain all the documentation specific to that version.

Whilst the version is still under development this folder will have “- IN PROGRESS” appended to its name.

Once the version is completed (i.e. tagged on Github), the folder will have the “- IN PROGRESS” label removed, a zip file of the code and a copy of the model outputs saved into it and should not be edited from that point onwards.

Instead, a new “- IN PROGRESS” folder should be created, with below documents from the previous version copied into it, that can then be edited alongside changes to the code for the new version.

	Description
Technical Document	A full description of the model including code maps and example calculations. Should be detailed enough to allow for an external to recreate the model.
Assumptions Logs	A record of assumptions we have made throughout the model.
Data Logs	A record of data inputs used by LAPCAP.
User Guide	Guidance on how to practically run and control LAPCAP. Stored in the README file in our GitHub repository.
Change Log	A record of changes in output numbers for merges between versions.
Verification Log	A record of verification done on each merge. Maintained by our quality assurance lead (Peter Neary).