Changes

Jump to: navigation, search

Windows installer

569 bytes added, 07:47, 30 October 2020
Additional plugins
{{languages|Windows installer}}{{man warn|These are the original instructions for installation on Windows of Gramps 3.4.x and earlier|They were written when a Windows user also had to (manually) install various other programs ("dependencies") in order to get Gramps to work.<br>'''A much easier way to install Gramps on Windows is to use the "all-in-one" [[All In One Gramps Software Bundle for Windows|installer]], since it has all the needed programs ("bundled")'''. {{man menu|[[Download#MS_Windows]]}}}} {{stub}}
Because Gramps has been designed and written in multi-platform resources (including Python and GTK), we have created a Windows installer that has been reported to work without any obvious issues.
We do suggest the following:
* Work with ''a copy'' of your main database and keep regular backups in the [[GRAMPS_XML|GRAMPS Gramps XML]] format.* Join the [https://lists.sourceforge.net/lists/listinfo/gramps-users GRAMPS Gramps Users mailing list] to share your experiences, especially if you are a developer able to contribute to a Windows port.* See also [[GRAMPS Gramps and Windows]] for a collection of hints to run GRAMPS Gramps on MS Windows.
* Report any issues you find to help make Gramps better.
==Installation==
These instructions are specific to the GRAMPS Gramps (minimal) installer, which requires you to independently install GRAMPS Gramps dependencies prior to installing GRAMPSGramps. Please ignore these instructions if you are using either the GRAMPS Gramps AIO installer or Portable GRAMPS Gramps application.
(The GRAMPS Gramps AIO ("all-in-one") installer contains all the dependencies GRAMPS Gramps needs and many people find it much easier to install GRAMPS Gramps that way. See [[All In One Gramps Software Bundle for Windows|GrampsAIO]] for more information.)
When you need to install the dependencies for GRAMPS Gramps there is the easy way and the hard way. You would only use the hard way if you have specific requirements ( such as specific versions ) that are not covered by the easy way.
The essential dependencies that GRAMPS Gramps requires to run are:* Python 2.6.x or later (GRAMPS Gramps trunk has not yet been ported to Python 3.xand has different dependancies)
* GTK runtime
* GTK python bindings ( PyGTK, PyGObject, PyCarioPyCairo)
=== Dependencies - The easy way ===
Select the correct version of Python dependent on your operating system.
{{man tip|Tip: |Currently The (2011-6-20) the minimal installer only comes in came as a '''32 bit''' version, if you are running on a 64 bit operating system '''select a 32 bit Python installer'''}}
;For Gramps 3.1.x and laterto 3.4.x
{| {{prettytable}}
!Order
|}
'''3.''' Install GRAMPS Gramps for Windows. You can download the most recent stable version from [https://sourceforge.net/projects/gramps/files/ SourceForge].
=== Dependencies - The hard way ===
'''2.''' Install the packages in the following order:
;For Gramps 3.1.x and laterto 3.4.x
{| {{prettytable}}
!Order
The following recommendations are for the validation
of the proper installation of the above listed
GRAMPS Gramps software prerequisites.
After installing the items above on a VISTA 64 bit
Ultimate System; GRAMPS Gramps could not locate any of
the above software except for Python. This caused
the installer to not install GRAMPSGramps.
After some time researching the issue I found
The above items should complete without errors.
5. If you are updating from a prevous GTK version, make sure you have "Graphviz" folder path AFTER the "GTK2 runtime 2.16" folder.
It should look like this (in this order) PATH=... C:\Program files\GTK2 Runtime\bin;C:\Program files\Graphviz2.26\bin;C:\Program files\GS\GS8.64\bin. If "Graphviz" is located before "GTK2 Runtime 2.16" in the PATH folder order GRAMPS Gramps will not start.
6. Reboot your computer. After reboot run GRAMPS Gramps install.
|-
|<!--Order-->Optional
* pygtk 2.10.6 => [http://ftp.acc.umu.se/pub/GNOME/binaries/win32/pygtk/2.10/pygtk-2.10.6-1.win32-py2.5.exe pygtk-2.10.6-1.win32-py2.5.exe] (1.8 MB, from [http://www.acc.umu.se www.acc.umu.se])
'''3.''' Re-boot the computer after installing the above dependencies, prior to installing GRAMPSGramps.
'''4.''' Install GRAMPS Gramps for Windows. You can download the most recent stable version from [https://sourceforge.net/projects/gramps/files/ SourceForge].
==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 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].)
===Hang when started===
In some environments GRAMPS Gramps may be unresponsive after displaying its window after being started, particularly after the first time. This can be worked around by running GRAMPS Gramps via a BAT file which first sets GRAMPSHOME to an accessible directory, as discussed on the [[GRAMPS_and_WindowsGramps_and_Windows#Setting_the_configuration_path|''GRAMPS Gramps and Windows'' page]].
==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 graph and code generatoroutput formats) 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 [httphttps://pageswww.csghostscript.wisc.educom/~ghost/ ghostscriptGhostscript]. After installation, if gswin32.exe or gswin32c.exe is in the path, PDF should appear as one of the formats in the graphical Relationship Graph report.
* '''Spell-checking:'''
*# For spell-checking to work you first need [httphttps://wwwabiword.abisourcegithub.com/projectsio/enchant/ Enchant library] and python bindings [httphttps://wwwpypi.rfk.idpython.auorg/softwarepypi/pyenchant/ PyEnchant]. Enchant appears to be a generic spell checking library. You can request dictionaries from it, ask if a word is correctly spelled, get corrections for a misspelled word, etc... PyEnchant is a set of language bindings and some wrapper classes to make the excellent Enchant spellchecker available as a Python module. Both are available for windows as single setup file:
*#* [http://pypi.python.org/packages/any/p/pyenchant/pyenchant-1.5.3.win32.exe pyenchant-1.5.3.win32.exe]
*# Secondly you need [http://www.pygtk.org/pygtkspell/ PyGTKSpell] from [http://www.pygtk.org/about.html gnome-python-extras] which is bindings allowing to run Python programs using the [http://gtkspell.sourceforge.net/ GtkSpell library], that extends GTK+'s GtkTextView widget with support for spell-checking. Depending of yours Python version download and install one of these:
==Limitations==
When this minimal Windows installer was first written, there was no intent to package all the dependencies and the GRAMPS Gramps package into one installer. It is very complex to coordinate dependencies between GRAMPS Gramps and these other projects. It also means a single 30+ MB download every version change. However, later such a package was created and many people find it easier than personally installing all the dependencies; see [[Gramps_Software_Bundle_for_Windows All In One Gramps Software Bundle for Windows| GrampsAIO]] for more information.
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(List gone)] archive.
On Windows Vista you will need to save the executable using "save as" and run it as administrator, otherwise the programs will not be able to write to the registry on installation. To do that right click the saved file and choose "run as administrator".
== See also ==
* [[GRAMPS Gramps and Windows]] describes users experiences using GRAMPS Gramps on Windows.* [https://lists.sourceforge.net/lists/listinfo/gramps-users GRAMPS Gramps users mailing list]* [[Gramps for Windows with MSYS2]] 
[[Category:Documentation]][[Category:Developers/Packaging]]
301
edits

Navigation menu