Gwyddion – Free SPM (AFM, SNOM/NSOM, STM, MFM, …) data analysis software

Documentation

User documentation, Manual pages, Pygwy documentation, Developer documentation, FAQ (Frequently Asked Questions).

Miscellaneous:

User documentation

User documentation consists of Gwyddion User guide which is available in several languages. Note the English version is primary; the other language versions may or may not be as complete as the English guide. The guide is updated continuously and may occasionaly describe features present only in the development snapshots of Gwyddion.

HTML version for on-line browsing:

English
French
Russian

the same HTML version, packed to an archive:

English, HTML archive: gwyddion-user-guide-xhtml-en.tar.gz2017-02-219.66 MB
French, HTML archive: gwyddion-user-guide-xhtml-fr.tar.gz2017-02-2110.4 MB
Russian, HTML archive: gwyddion-user-guide-xhtml-ru.tar.gz2017-02-2111.1 MB

and PDF version suitable for printing:

English, PDF (A4 paper): gwyddion-user-guide-en.pdf2017-02-219.64 MB
French, PDF (A4 paper): gwyddion-user-guide-fr.pdf2017-02-2110.2 MB
Russian, PDF (A4 paper): gwyddion-user-guide-ru.pdf2017-02-2111 MB

Known problems in the PDF version:

DocBook source: gwyddion-user-guide.tar.gz2017-02-2117.7 MB

Gwyddion user guide can be copied, distributed and/or modified under the terms of either GNU General Public License or GNU Free Documentation License.

Manual pages

Unix manual pages of Gwyddion commands are now part of the user guide:

gwyddion(1)
gwyddion-thumbnailer(1)

Pygwy documentation

Python scripting introduction and general description can be found in the pygwy section of the user guide.

See also the installation chapter which describes how to get python scripting working in different operating systems.

The Python API documentation lists all the available classes, methods and functions. It it is mostly generated from the C API documentation, therefore it can be occasionally a bit confusing (read: wrong).

Developer documentation

Developer documentation consists of API reference of Gwyddion libraries (for core developers and module authors), and Module tutorial (for module writers) and Plug-in proxy reference (for plug-in writers) that are included in libgwymodule documentation.

Two different versions of API documentation exist: stable which describes the last stable Gwyddion version (currently 2.47); and the nightly generated one, which reflects whatever state the source tree currently is. Gwyddion version a function or other symbol was introduced in is noted in its entry, at least in the stable documentation. API documentation is also present in source tarballs and development packages.

Stable (2.47)

Subversion trunk (head)

1.110 (yeti, 2016-11-25 09:40:05)
© David Nečas and Petr Klapetek

Home Download News Features Screenshots Documentation English guide French guide Russian guide FAQ Communicate Participate Resources Applications Site Map

Valid XHTML 1.0 Valid CSS