About the manual

Two manuals, as in difes, written for the release they describe.

Using the app and the core

How to open data, build a refinement, run it, read the result; the menus, the editor, the command line. Every command is run before it is published.

Theoretical basis

The crystallography and the refinement mathematics the core implements: space groups, structure factors, peak shapes, corrections, least squares, agreement factors and uncertainties. Each equation is written in the code's convention, cites its source and points to the function that implements it.

Where it is

From app 0.14.0 the manual for using the app is in the app itself, under Help ▸ diff-ref-struct Manual, and works offline. It has seven pages and 101 sections:

• the app's own page: the window, projects and their files, Settings, the keyboard, and the workflows step by step;
• one page per module (Data, Refine, Editor, Explore): every view, panel, dialog and field, and the core function behind each;
• the three pages of this site below, the same text.

A ? on each panel opens it at the section for what is on screen. The site's pages:

• Files: the files of a project, each with its role and name.
• Data operations: what can be done to a data file, each operation the core's.
• Parameters: the theory: every parameter from the parameter dictionary, with its equation and source.