Documentation

User documentation, Developer documentation, FAQ (Frequently Asked Questions).

Miscellaneous:

• A slightly technical overview of Gwyddion design.
• Motivation, a document predating Gwyddion and explaining circumstances that led to its creation.
• What is new in 2.0, an overview of major user-visible changes in Gwyddion 2.0.
• Some plans for future versions and version numbering explanation.

User documentation

Consists of Gwyddion User guide, available here for on-line browsing. This document is now being writen; however, basic information is already there.

You can also download complete user guide here for off-line reading:

You probably want the ready-to-read HTML, not the DocBook XML sources. The guide is distributed as a plain pack of HTML files, point your Web browser to index.html to start reading.

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

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.10); 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 documentation index (2.10):

• libgwyddion – Gwyddion core library
• libgwyprocess – Gwyddion data processing library
• libgwydraw – Gwyddion drawing library
• libgwydgets – Gwyddion widget library
  • Data windows and views
  • Graph
  • 3D Widgets
  • General widgets
  • Widget utilities
• libgwymodule – Gwyddion module library
  • Module library
  • Module tutorial
  • Plug-in proxy reference
• libgwyapp – Gwyddion application library

Subversion trunk (head) documentation index:

• libgwyddion – Gwyddion core library
• libgwyprocess – Gwyddion data processing library
• libgwydraw – Gwyddion drawing library
• libgwydgets – Gwyddion widget library
  • Data windows and views
  • Graph
  • 3D Widgets
  • General widgets
  • Widget utilities
• libgwymodule – Gwyddion module library
  • Module library
  • Module tutorial
  • Plug-in proxy reference
• libgwyapp – Gwyddion application library
• pygwy – Python interface, for now it is mostly generated from the C API documentation, therefore it can be a bit confusing (read: wrong)
• Pygwy tutorial – An introduction to Pygwy: Gwyddion binding to Python language