OOF2: The Manual

2. About This Manual

Chapter 1 describes how to acquire, install, and start OOF2. If you're fortunate enough to have OOF2 already installed, you can skip most of this chapter, although you may want to read Section 1.3 to learn about the on-line tutorials.

Chapter 2 discusses the various objects (Microstructures, Fields, Meshes, etc.) that OOF2 manipulates. It would be a good idea to read this now, although the rest of the manual (the on-line version, at least) links back to it frequently.

The main OOF2 GUI consists of a bunch of Task Pages. Chapter 3 describes each page in detail. This is where you go to learn how to do something specific.

The OOF2 Graphics Window is covered in Chapter 4. It discusses how to control what is displayed in the window, and all the operations that require graphical interaction (selecting pixels with the mouse, for example).

Chapter 5 discusses the remaining parts of the OOF2 GUI.

Chapter 6 is the OOF2 Reference Manual. All operations in the GUI have a text counterpart. These text commands form a hierarchical system of menus. Chapter 6 lists and describes all of the commands in detail, as well as all of the objects that can be used as arguments to those commands.

Chapter 7 and Chapter 8 describe how to add new features to OOF2. Chapter 7 discusses the mechanics: which files need to be created, where to put them, and how to compile them into an OOF2 extension module. Chapter 8 discusses the contents of the files. It describes the classes and subroutines that need to be written and provides examples.

This manual was written in DocBook 4.5 XML, and converted to html with saxon 6.5.3.