What is in an Example Tree?
The example family tree database (
example.gramps file) ideally will have an example of everything, at least one, of everything Gramps does, or which it is possible to do in Gramps, even if obscure etc.
Before filing a bug report...
Is your Tree damaged? When you suspect that you have discovered an issue (aka 'bug') in Gramps, first try the same operation with the example family tree.
The purpose of an Example Tree
Your installation of Gramps should include some example family tree data. This data is used for working through tutorials and for safely exploring tools or features.
And, because many of the features of Gramps cannot be explored until the Tree is populated with People, Families, Events, Places, Sources, Media and other types of data; importing the example data creates a playground for exploring Gramps.
Further, most of the examples, "How do I..." tutorials and screen-capture illustrations (aka figures) in this wiki are based on this example data freshly imported into a newly created (empty) tree. So, by using this data when following instructions on a new technique, you should see the same results.
This eliminates the ambiguity and wonder if a different result was because you didn't correctly apply the technique or your data had a critical difference. That lets you focus appropriately: on improving your technique or repairing your data.
The example is also used to provide a known, stable and predictable environment for testing. Many conditions cannot be recreated without tree data. Using this tree (as a common frame of reference) eliminates the extra complexity of describing how to recreate the data before describing the issue.
Follow these steps to bring the external file "example.gramps" into a family tree database:
example.gramps.gzon your system.
For example in each Operating System:
- on Linux,
/usr/share/doc/gramps/example/gramps/. If the file is named
example.gramps.gz, rename it to
example.grampsand gramps will recognize it. You can copy this file to a temporary location or import it directly from this directory.
- on MS-Windows v5.1.6 AIO,
C:\Program Files\GrampsAIO64-5.1.6\share\doc\gramps\example\gramps(On MS-Windows, ensure you can see hidden files; see User Directory:MS Windows)
- on Apple macOS, the example database is located inside the application bundle at
- on Linux,
- Start Gramps
- Create a new family tree
- If the "Family Tree - Gramps" dialog did not appear automatically when starting Gramps, select the Family Tree ➡ Manage Family Trees... menu option or use the keybinding Ctrl+o
- select the New button.
- Give it some name, such as example
- select the Load Family Tree button to open this highlighted new family tree. With this empty tree, the interface will be distressingly bare.
- import the example.gramps file
- Use Family Trees ➡ Import... menu or use the keybinding Ctrl+i to open the File Chooser
- browse to the folder found in step 1
The default file chooser navigation option for filepaths is to displaying each hierarchical level using clickable breadcrumb navigation. If you would rather type (or paste) in the path found above, press the Ctrl+L keybinding to swtch from breadcrumbs to an editable text box.
- click the
example.grampsitem to highlight (aka "select") the file
- click the highlighted file again to begin the import
Import Statistics of the example.gramps family tree
Number of new objects imported:
Media objects with relative paths have been imported. These paths are considered relative to the media directory you can set in the preferences, or, if not set, relative to the user's directory.
Connecting to the example Media Objects
There are seven example Media Objects (images in JPEG and PNG file format) distributed with the example.gramps tree. The filepaths specified in the tree use a relative media path as the starting point (the Base path for relative media paths:). The default directory (defined in the Preferences) uses a different starting point.
So these images won't be locatable until the media path has been re-defined. And the Preview thumbnails will display 'broken link' icon of a box with a red 'x'.
The media path can be reset now or if starting to experiment with images.
- In Edit > Preferences, change the Base path for relative media paths: in the General tab. This could be in a new directory, to keep it separate to your own family tree media. (e.g. On Linux
- Copy the media files from the example directory (that you found in step 1, above) to this media path directory.
The example.gramps family tree data file
Alternately, a replacement Gramps example.gramps XML family tree database file (without the Media Objects) can be downloaded from the GitHub file store.
- Gramps Tutorial #2: Creating Backups & Updating your Software YouTube video by TechTutorials.
Importing the Example.gramps Tree begins at 17 minutes 4 seconds.
- Data.gramps - a smaller (60 person) sample file
- sample.ged - a 42 person GEDCOM tree
(hint: GEDCOM files do not specify a Home Person. Edwin Michael Smith is a reasonable person to set as Home Person.)
- for MS Windows, located in C:\Program Files\GrampsAIO64-5.1.6\share\doc\gramps\example\gedcom\
- PseudonymTree.gramps - sample Pseudonym person Gramps tree for exploring filters & charts. (No Events or Media)
- Gramps-Project example files (GitHub folder)
- testcase file generator
- Backup and data recovery
- Feature request 12394 : example.gramps tree changes requested for version 5.2 wiki manual illustration purposes
- Data added Jun 2015 to Example.gramps for Gramps 4.2 : custom parent relationship, notes.
- History of Example.gramps changes