Difference between revisions of "Windows installer"

From Gramps
Jump to: navigation, search
(changed formatting and added link to GRAMPS and Windows)
Line 1: Line 1:
 
{{languages}}
 
{{languages}}
  
 
+
= Introduction =
  
 
'''GRAMPS is not ''designed'' to run on Microsoft Windows and should be regarded as experimental.''' Because it ''has'' been designed to use the multi-platform toolsets Python and GTK, a few volunteers have created a test installer that a few users report to work without too many obvious issues. But there are currently no GRAMPS developers committed to this platform.
 
'''GRAMPS is not ''designed'' to run on Microsoft Windows and should be regarded as experimental.''' Because it ''has'' been designed to use the multi-platform toolsets Python and GTK, a few volunteers have created a test installer that a few users report to work without too many obvious issues. But there are currently no GRAMPS developers committed to this platform.
Line 25: Line 25:
 
## [http://downloads.sourceforge.net/gramps/gramps-3.0.0-2.exe gramps-3.0.0-2.exe] -- (4.2 MB) GRAMPS one-click installer for Windows, with support for 20 languages.
 
## [http://downloads.sourceforge.net/gramps/gramps-3.0.0-2.exe gramps-3.0.0-2.exe] -- (4.2 MB) GRAMPS one-click installer for Windows, with support for 20 languages.
  
===Common Problems===
+
==Common Problems==
  
====Installer complains pygtk is missing====
+
===Installer complains pygtk is missing===
 
This is a very common error to see when all dependencies are not installed or installed correctly. Please make sure that each of the packages required have installed correctly, and re-boot the computer prior to running the GRAMPS installer. We often see users attempting to use other packages to satisfy these requirements that omit something necessary (e.g., glade) which produce this error.
 
This is a very common error to see when all dependencies are not installed or installed correctly. Please make sure that each of the packages required have installed correctly, and re-boot the computer prior to running the GRAMPS installer. We often see users attempting to use other packages to satisfy these requirements that omit something necessary (e.g., glade) which produce this error.
  
 
In rare occasions, the installer will complain that pygtk is not installed even though everything is correct. Canceling and re-running the installer seems to fix this problem, although if it happens repeatedly, the error is the more severe situation discussed above. (Anyone know why? Please tell us on the [https://lists.sourceforge.net/lists/listinfo/gramps-windows gramps-windows email list].)
 
In rare occasions, the installer will complain that pygtk is not installed even though everything is correct. Canceling and re-running the installer seems to fix this problem, although if it happens repeatedly, the error is the more severe situation discussed above. (Anyone know why? Please tell us on the [https://lists.sourceforge.net/lists/listinfo/gramps-windows gramps-windows email list].)
  
====GTK+ Installer Error====
+
===GTK+ Installer Error===
 
If you already have GTK+ installed, perhaps because you have installed [http://gimp-win.sourceforge.net/stable.html The GIMP], [http://www.pidgin.im/ Pidgin], or [http://gnucash.org Gnu Cash], the GTK+ installer will not be able to write to some files if one of those applications is running. If you see errors with the GTK+ installer, select Cancel, shut down the other GTK+ applications and run the installer again. (This issue has been reported as [http://sourceforge.net/tracker/index.php?func=detail&aid=1852930&group_id=98754&atid=621933 GTK+ Installer doesn't handle locked files well] to the kind people who make the GTK+ installer for windows.)
 
If you already have GTK+ installed, perhaps because you have installed [http://gimp-win.sourceforge.net/stable.html The GIMP], [http://www.pidgin.im/ Pidgin], or [http://gnucash.org Gnu Cash], the GTK+ installer will not be able to write to some files if one of those applications is running. If you see errors with the GTK+ installer, select Cancel, shut down the other GTK+ applications and run the installer again. (This issue has been reported as [http://sourceforge.net/tracker/index.php?func=detail&aid=1852930&group_id=98754&atid=621933 GTK+ Installer doesn't handle locked files well] to the kind people who make the GTK+ installer for windows.)
  
 
==Additional plugins==
 
==Additional plugins==
  
There are some features of Gramps that need additional programs to work. There are several different kinds of reports, and the following features need extra configuration.  
+
There are some features of Gramps that need additional programs to work. There are several different kinds of reports, and the following features need extra configuration to work on Windows.  
  
 
* The Relationship Graph reports (both graphical report and code generator) need an installation of [http://www.graphviz.org  Graphviz]. There is a bug in the current stable release, see this [[Howto:_Make_a_relationship_chart#Example_3.2C_Generating_the_graph_by_using_the_Graphviz_command_line_tool |example]].
 
* The Relationship Graph reports (both graphical report and code generator) need an installation of [http://www.graphviz.org  Graphviz]. There is a bug in the current stable release, see this [[Howto:_Make_a_relationship_chart#Example_3.2C_Generating_the_graph_by_using_the_Graphviz_command_line_tool |example]].
 +
* The Relationship Graph can not use PDF as output format unless there is an installation of [http://pages.cs.wisc.edu/~ghost/ ghostscript]. After installation, if gsview32.exe or gsview32c.exe is in the path, PDF should appear as one of the formats in the graphical Relationship Graph report.
  
* The Relationship graph can not use PDF as output format unless there is an installation of [http://pages.cs.wisc.edu/~ghost/ ghostscript]. After installation, if gsview32.exe or gsview32c.exe is in the path, PDF should appear as one of the formats in the graphical Relationship Graph report.
+
=Limitations=
 
 
==Limitations==
 
  
 
At this time, there is no intent to package all the dependencies and the GRAMPS package into one installer. This creates a very complex coordination condition between GRAMPS and these other projects. It also means a single 30+ MB download every version change.  
 
At this time, there is no intent to package all the dependencies and the GRAMPS package into one installer. This creates a very complex coordination condition between GRAMPS and these other projects. It also means a single 30+ MB download every version change.  
  
 
There have been discussions about trying to install compiled distillations (dynamic link libraries) of these core dependencies to avoid having to install the entire Python and GTK environment, but this work never progressed beyond discussion. For more about this and other Windows issues, see the [https://lists.sourceforge.net/lists/listinfo/gramps-windows email list] archive.
 
There have been discussions about trying to install compiled distillations (dynamic link libraries) of these core dependencies to avoid having to install the entire Python and GTK environment, but this work never progressed beyond discussion. For more about this and other Windows issues, see the [https://lists.sourceforge.net/lists/listinfo/gramps-windows email list] archive.
 +
 +
= See also =
 +
* [[GRAMPS and Windows]] describes users experiences using GRAMPS on Windows.
  
 
[[Category:Documentation]][[Category:Developers/Packaging]]
 
[[Category:Documentation]][[Category:Developers/Packaging]]

Revision as of 09:05, 24 October 2008

Introduction

GRAMPS is not designed to run on Microsoft Windows and should be regarded as experimental. Because it has been designed to use the multi-platform toolsets Python and GTK, a few volunteers have created a test installer that a few users report to work without too many obvious issues. But there are currently no GRAMPS developers committed to this platform.

Because the software is not formally tested and we get very little feedback about it, we will continue to maintain this warning: GRAMPS on Windows could become unstable or may subtly compromise your data. If you choose to use this:

  • Work with a copy of your main database and keep regular backups in the GRAMPS XML format.
  • Do not recommend it to Windows users as a stable genealogy application.
  • Join the GRAMPS Windows mailing list to share your experiences, especially if you are a developer able to contribute to a Windows port.
  • See also GRAMPS_and_Windows for a collection of hints to run GRAMPS on MS Windows

Installation

  1. Close any gtk-based applications that are running, such as the GIMP or Pidgin. See additional note below.
  2. Install the packages in the following order:
    1. Python 2.5.1 => python-2.5.1.msi (10.7 MB, from python.org)
    2. GTK+ 2.10.11 => gtk-dev-2.10.11-win32-1.exe (11.9 MB, from gladewin32, includes glade, see note)
    3. pygtk 2.10.6 => pygtk-2.10.6-1.win32-py2.5.exe (1.8 MB, from www.acc.umu.se)
    4. pygobject 2.12.3 => pygobject-2.12.3-1.win32-py2.5.exe (163 KB, from www.gnome.org)
    5. pycairo 1.2.6 => pycairo-1.2.6-1.win32-py2.5.exe (82 KB, from www.acc.umu.se)
  3. Re-boot the computer after installing the above dependencies, prior to installing GRAMPS.
  4. Install GRAMPS for Windows. You can install the last stable version:
    1. gramps-3.0.0-2.exe -- (4.2 MB) GRAMPS one-click installer for Windows, with support for 20 languages.

Common Problems

Installer complains pygtk is missing

This is a very common error to see when all dependencies are not installed or installed correctly. Please make sure that each of the packages required have installed correctly, and re-boot the computer prior to running the GRAMPS installer. We often see users attempting to use other packages to satisfy these requirements that omit something necessary (e.g., glade) which produce this error.

In rare occasions, the installer will complain that pygtk is not installed even though everything is correct. Canceling and re-running the installer seems to fix this problem, although if it happens repeatedly, the error is the more severe situation discussed above. (Anyone know why? Please tell us on the gramps-windows email list.)

GTK+ Installer Error

If you already have GTK+ installed, perhaps because you have installed The GIMP, Pidgin, or Gnu Cash, the GTK+ installer will not be able to write to some files if one of those applications is running. If you see errors with the GTK+ installer, select Cancel, shut down the other GTK+ applications and run the installer again. (This issue has been reported as GTK+ Installer doesn't handle locked files well to the kind people who make the GTK+ installer for windows.)

Additional plugins

There are some features of Gramps that need additional programs to work. There are several different kinds of reports, and the following features need extra configuration to work on Windows.

  • The Relationship Graph reports (both graphical report and code generator) need an installation of Graphviz. There is a bug in the current stable release, see this example.
  • The Relationship Graph can not use PDF as output format unless there is an installation of ghostscript. After installation, if gsview32.exe or gsview32c.exe is in the path, PDF should appear as one of the formats in the graphical Relationship Graph report.

Limitations

At this time, there is no intent to package all the dependencies and the GRAMPS package into one installer. This creates a very complex coordination condition between GRAMPS and these other projects. It also means a single 30+ MB download every version change.

There have been discussions about trying to install compiled distillations (dynamic link libraries) of these core dependencies to avoid having to install the entire Python and GTK environment, but this work never progressed beyond discussion. For more about this and other Windows issues, see the email list archive.

See also