D Sources and working files

D.1 The implementations described

The extractor and Reader descriptions refer to the published protein-extract-and-view-tools source release, revision 8714b8ca6e859236f46d17e16c79dfe896780ff8. Reader is in its h5-reader subdirectory.

The prediction chapter describes the published nmr-models implementation at revision cb077c91faa0197d6fa86928981172f313e2bb6a, also used for the code walkthrough and model inventory.

Source paths are relative to the implementation described in each chapter. Line numbers refer to these versions.

D.2 The documentation project

This book belongs to the independent project C:/projects/nmr-extract-architecture. Edit the chapters in latex/chapters/; latex/book.tex assembles them, and latex/layout.tex controls the layout.

D.3 Diagrams and evidence

Editable Gaphor models for the extractor and prediction class diagrams are in model/ and prediction/model/. Other explanatory diagrams use PlantUML or SVG sources under the corresponding diagrams/ directories. The latex/figures/ directory contains vector PDF copies for printing.

The numerical tables and class/function maps are in prediction/analysis/. Reader’s compiler-derived class views are in reader/analysis/generated/.

D.4 Rebuilding

From the documentation project root, the local command is:

.\latex\build.ps1

The build uses a XeTeX-compatible engine and the included vector figures. It does not require the software repositories, datasets, fitted weights, Qt, Gaphor or Python. On another system, open book.tex with its folder as the working directory and compile with XeLaTeX; repeat until references settle. The supplied script uses Tectonic, which repeats those passes automatically.

The output is output/pdf/book.pdf under the project root.