Difference between revisions of "Installation"

From Gramps
Jump to: navigation, search
m (Latest Released Version: 3.1.2 -> 3.1.3)
m (Obtaining the source)
Line 217: Line 217:
 
'''1. Download a Stable Version'''
 
'''1. Download a Stable Version'''
  
* The latest stable version of GRAMPS can be downloaded from the [http://sourceforge.net/projects/gramps GRAMPS SourceForge page]. Eg: gramps-3.1.2.tar.gz. Extract this file into a directory:
+
* The latest stable version of GRAMPS can be downloaded from the [http://sourceforge.net/projects/gramps GRAMPS SourceForge page]. Eg: gramps-3.1.3.tar.gz. Extract this file into a directory:
 
<code>
 
<code>
 
   tar xzvf gramps-zzz.tar.gz
 
   tar xzvf gramps-zzz.tar.gz

Revision as of 14:50, 6 December 2009

Latest Released Version

The latest released version is GRAMPS 3.1.3. This version may not yet be available for installation on your platform. Please visit the Download page for more information.

Upgrading GRAMPS

If you are Upgrading GRAMPS from a previous version you should first:

  1. Use your old version of GRAMPS to export your Family Trees to GRAMPS XML (uncheck privacy options on Exporter Assistant)
  2. Uninstall your old version of GRAMPS
  3. Install the new version of GRAMPS by following the instructions below
  4. Create a new Family Tree
  5. Import your old GRAMPS XML data

Additional software GRAMPS can benefit from

GRAMPS does not rely on the following programs, however, having them will increase your productivity:

  • Spell checking: Installing python-gnome2-extras and python-enchant provides the gtkspell module and the enchant module, which adds spell checking in the notes
  • Graphviz, Inkscape: Gramps can make nice Genealogical trees (relationship graphs). These are generated by the Graphviz package, which defines a code (dot), as well as programs to produce graphs (dotty, to be called from command line). This gives you as researcher most power over how your tree will look, but has a learning curve. Also, kgraphviewer works fine with dot generated by GRAMPS. An alternative is to make a graphical report, converting the tree to an svg file, which you then can open/edit/refine in eg Inkscape.
  • ttf-freefont: Useful as a font that supports a large subset of the unicode and is a true type. This works well with both print and graphviz output.
  • XdgUtils is a set of command line tools that assist applications with a variety of desktop integration tasks. About half of the tools focus on tasks commonly required during the installation of a desktop application and the other half focuses on integration with the desktop environment while the application is running. Even if the desktop components of your application are limited to an installer, configuration or management tool, Xdg-utils provides you with an easy way to enhance the usage experience of your customers by improving the integration of these components in the user's environment.

Other packages might also be useful:

  • desktop-file-utils: see list of programs to open a media file on right click on an image

Linux

Automatic download and install of GRAMPS

Before downloading GRAMPS from this site, see if your operating system's repository makes the current version available. To see what the current version is, visit GRAMPS stable on Sourceforge and look at the version number of the top package.

To check what is available specifically for your Linux operating system some methods are listed below:

Linux Operating System Command Line
Debian based systems
(Ubuntu & variants, Mepis,...)
apt-get install gramps
Gentoo (and Sabayon) emerge gramps
Mandriva urpmi gramps
Redhat based systems
(Fedora, CentOS...)
yum install gramps
OpenSUSE sudo zypper install gramps

Manual download and install of GRAMPS

If your Linux operating systems repository does not have the current version, then you may be able to download it from this site. Some helpful users of GRAMPS have made packages for various systems. If you are lucky you'll find your system below. If it's missing you can contact the developers email list for advice.

Ubuntu and derivatives

Repository packages for Ubuntu and derivatives (Kubuntu, Mephis, LinuxMint, ...): are available on GRAMPS download page.

Ubuntu (Version) GRAMPS
Release
Download
Jaunty Jackalope (9.04) 3.1.2 gramps_3.1.2-1_Ubuntu904.deb
Intrepid Ibex (8.10) 3.1.2 gramps_3.1.2-1_Ubuntu810.deb
Hardy (8.04) 3.1.2 gramps-3.1.2-1_Ubuntu804.deb
Gutsy (7.10) 3.0.3 gramps_3.0.3-1_ubuntu710.deb
Feisty (7.04) 2.2.10 Download gramps_2.2.10-1_all.deb
and gramps-help_2.2.10-1_all.deb, and install with your package manager.
Dapper, Edgy
and earlier versions of Ubuntu
2.2.8 Download gramps_2.2.8-1dapper1_all.deb
and gramps-help_2.2.8-1dapper1_all.deb, and install with your package manager.

Debian

Debian: the latest version should be in the unstable repository (Sid Gramps) and can be upgraded from your package manager. The testing repository is updated 10 days later (except near a new stable release), see Testing Gramps.

SuSE

SuSE: Richard Bos has been providing the GRAMPS releases for OpenSUSE. The repository for OpenSUSE 11.1 is available from [1]. Note that at the time of writing this repository is not the same as that in the repository list as "Education" and must be added as a URL. The repository for 11.0 is [2] and 10.3 is [3]. For earlier versions of OpenSUSE (10.2) see the forum entry about satisfying GRAMPS dependencies for SuSE with the rbos and SMART. Also, there is an other alternative using openSUSE BuildService.

Mandriva

Mandriva: Newer versions of GRAMPS are sometimes backported. To install backports you must enable the backports repository (make sure you understand the instructions on the Mandriva wiki). If the latest version is not in the backports repository you cab try the contrib repository.

Fedora

Fedora: For Fedora Core look on the GRAMPS download page for a package containing fc with your number and ending with .rpm. The alternative to installing from source is to build a package from an rpm spec file, or install a binary from fedora testing.

Different GNU/Linux distributions

Different GNU/Linux distributions have other preferred ways to download and install packages for GRAMPS. Please read the installation instructions specific to your distribution before downloading.

In all other cases, you must download the source package (the file ending with '.tar.gz') and install GRAMPS manually. See the section about installing from source for details.

Gnome and KDE

You can use both, but GRAMPS fits in better with GNOME.

For KDE there are some minor issues due to some (GTK) issues outside of GRAMPS. Check the KDE page to know what these problems might be.

For GNOME, there are some issues due to some (ATK/GAIL) issues outside of GRAMPS. Check the Known issues to know what these problems might be.

Also, you might look at XdgUtils.

GRAMPS on handhelds

GRAMPS can run fine on some small-factor devices. Users have been successful in using GRAMPS on:

Live Genealogy CD

If you are interested in GRAMPS, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our Linux Genealogy CD. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install Ubuntu 8.04 and GRAMPS from the CD anytime you like.

Windows, FreeBSD, Mac OS X, Solaris

Windows

See the download page for the Windows installer, ensure you have downloaded and installed the Windows dependencies first.

Mac OS X

A new port of Gramps to Mac is available (July 2009). This is relatively untested and it is wise to back up data carefully before running it. It's available as a ready-built binary application for both Intel and PPC Macs. It's also available as a build environment and can be built from scratch by any Mac with the Apple Xcode toolset.

Mac for Gramps is described at Using Gramps on Apple Mac.

Macports and Fink versions of Gramps have been used in the past.

Free/OpenBSD and Solaris

For FreeBSD and Solaris there are experimental install instructions.

In case of error on FreeBSD 8.0, read ticket 3228.

Installing GRAMPS from source code

General Requirements

GRAMPS 3.1.x requires python 2.5 or greater, pygtk2 2.12 or greater, glade bindings and librsvg2

Linux Package Requirements

Debian /Ubuntu Fedora /Redhat Comment
python python Required (needs version 2.5 or later)
pygtk2 pygtk2 Required (needs 2.12 or greater)
xdg-utils xdg-utils Required for Gramps-3.1.x or later
rcs rcs Suggested for running
python-gnome2-extras Suggested for running (spell check)
python-enchant Suggested for running (spell check)
librsvg2-common librsvg2 Required for building
libglib2.0-dev Required for building
python-glade2 Required
librsvg2-devel Required for building
gnome-common Required for building
intltool intltool Required for building
gnome-doc-utils Required for building
gcc, make, gettext Required for building

Obtaining the source

There are two ways to get the source code: download a stable version source, or checkout the source from svn. Please, now is the time to read the INSTALL and README files accompanying the code. They come with the most recent information. Details on each download method:

1. Download a Stable Version

  • The latest stable version of GRAMPS can be downloaded from the GRAMPS SourceForge page. Eg: gramps-3.1.3.tar.gz. Extract this file into a directory:

  tar xzvf gramps-zzz.tar.gz

and then go into this directory:

  cd gramps-zzz

  • If you are interested in testing out the very latest development versions of GRAMPS, they can be obtained from SVN, see Brief introduction to SVN. The SVN versions of GRAMPS are potentially very dangerous as they have not been extensively tested - especially the "trunk" version which contains features that may still be partly implemented. Be aware that they may be prone to crashing and cause extensive data loss. Please use with extreme caution - and only ever on a copy of your data!

2. Download from SVN

You can get a branch version (similar as above) or the latest bleeding-edge version through SVN, such as:

svn co https://gramps.svn.sourceforge.net/svnroot/gramps gramps

or

svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.1.2 gramps

for the most recent development version, see Running a development version of Gramps.

Upgrading GRAMPS

If you have an older version of the GRAMPS source code installed you need to make a decision what you want to do with it before installing a later version. If you wish to keep the old version, make sure that you read the instructions in the INSTALL file regarding the use of the --prefix option to specify where the new version gets installed.

Should you just want to do a straightforward replacement instead, make sure that you remove the older version before you install the new version. Do not install over the top of the old version. As new versions of Gramps are developed, some functionality is occasionally rewritten in different ways. If you install over the top of an existing installation you run the risk that the old code left behind from the old version may be used instead of the new, sometimes with unintended consequences. If you installed from source, the best way of removing the old version is to run

 make uninstall

as root from where you installed the old version. Use your distribution's package manager to uninstall if your old version was installed as a package.

Note that you should use your old GRAMPS version to export backup copies to GRAMPS XML before removing the old version.

Linux

GRAMPS provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:

 ./autogen.sh   as user

This script will report any missing dependencies. Install these (see also INSTALL file). Building from source code typically requires that the development versions of the required libraries be installed. You might consider setting a prefix path with autogen.sh, see the INSTALL file for instructions. Standard install is in /usr/local.

Once a successful run of autogen.sh has been completed, you can run the typical make procedure.

 make (as user)

then

 make install (as root) 

BSD

Installing on BSD is as straightforward as on Linux, apart from some minor issues like tools having different names. See the BSD page for details.

Mac OS X

An overview of installing GRAMPS from source on the Mac is given under Installing from source code on Mac OS X

Windows

Fortunately for users of Microsoft Windows, some users have made a Windows installer. So far there have not been any reports of serious differences between the official builds of GRAMPS and the Windows Installer, so the future looks promising, but please, use this at your own risk.

Solaris

GRAMPS has been successfully installed from source on both Solaris 10 (SPARC) and OpenSolaris X86 (2008.05). Please see the Solaris page for step-by-step details.