Changes

==Introduction==This page gives information how to run Gramps 4{{man warn|Work in progress!!|Nobody guarantees anything at all!<br/>Any comments and help (e.0g.x from source on a Windows systemwiki pages) are welcome. After some trials there was the result to focus on 32 bit Python 2<br><br>Last update: 19.701.2014<br>Introducing the new PyGI-3 because of several issues related to Gtk and database connection. All steps were done by the author on Windows 7 64bit German10.2-AIO Package<br><br>'''Work in progress!!'''}}{{out of date}}

There are some parts marked as "TODO ISSUE" because of known issuesThis page provides information how to run Gramps 4.0.x from source on a Microsoft Windows system with a 32 bit Python 2.7.6.

There are some parts marked as :* "TODO ISSUE" because of known issues.* "TODO WORK" because it's not done yet done (work in progress).

{{man warn| This ==Windows operating system==* Win7.x: no special installations are known (all test done using Win7 Professional SP1 64bit German)* Win8.x: no information available* Win10.x: no information available* Win XP since April 8th 2014 is no longer supported by Microsoft and it is a work in progressrecommended you upgrade (How about upgrading to Linux :) )** If you would still like to use Win XP these additional installations are strongly required (all tests done using WinXP Home 32 bit German)*** SP3 (http://www.microsoft.com/de-de/download/confirmation. <braspx?id=25129)*** "Microsoft Visual C++ 2008 Redistributable Package (x86)" (http:/>Nobody guarantees anything at all!<br/>Any comments and help (ewww.gmicrosoft. on wiki pagescom/de-de/download/details.aspx?id=29) are welcome.}} Last update*** "Microsoft Visual C++ 2010 Redistributable Package (x86)" (http: 11//www.03microsoft.2013 (late evening in Germanycom/de-de/download/details.aspx?id=5555)

Requirements from the Gramps [http://sourceforge.net/p/gramps/source/ci/master/tree/READMEREADME]:

**We use: Python 2.7.3 6 32 bit from httphttps://www.python.org/getitdownloads/ (python-2.7.6.msi) for all examples assumed to be installed into "C:\Python27". **Comment: It's also possible to use Python 2.7.3 or 2.7.5 but always 32 bit (no experiences for 64 bit versions)**Comment: For Win7 user it's easier to don't not use "C:\Program Files (x86)\..." because for every change somewhere in this folder one has to activate the administrator's rights again and again.  ===PyGI AIO Package===With the help of an open source programmer we get this package (here again the authors personally thank for his good job supporting Gramps in this way - see there to know more about of his other work: http://opensourcepack.blogspot.de/2013/01/mypaint-and-pygi.html): * 19.01.2014: Download '''pygi-aio-3.10.2-win32_rev15-setup.exe''' or newer as a complete installer from:** http://sourceforge.net/projects/pygobjectwin32/files/*The PyGI AIO Package includes the following libraries for Gramps that should be selected during the installation process (you may choose libraries other for additional usages):** gdk-pixbuf (version 2.30.2 in pygi-aio-3.10.2-win32_rev15-setup.exe)** libgexiv2 (version 0.7.0 in pygi-aio-3.10.2-win32_rev15-setup.exe)** goocanvas (version 2.0.2 in pygi-aio-3.10.2-win32_rev15-setup.exe)** gtk+ (version 3.10.6 in pygi-aio-3.10.2-win32_rev15-setup.exe)** gtkspell (version 3.0.3 in pygi-aio-3.10.2-win32_rev15-setup.exe)** osm-gps-map (version 1.0.1 in pygi-aio-3.10.2-win32_rev15-setup.exe)** pango (version 1.36.1 in pygi-aio-3.10.2-win32_rev15-setup.exe)** webkitgtk (version 1.10.2 in pygi-aio-3.10.2-win32_rev15-setup.exe)* To run Gramps there is no need for pygi-aio's optionally provided developer tools.* Don't use the older GTK 3.8.6 (Select "No" as answer at the additional question dialogue!)* Deprecated versions before 15.12.2013 see history Comments (19.01.2014): * All gtk binaries are included in the pygi-aio installer package and correctly placed.* The pygi-aio package has no need for processors having an SSSE3 instruction set.

====Gtk, pyobject====

* GTK 3.0 8.7+ or greater

* cairo, pango, pangocairo with instrospection introspection bindings (the gi packages)

Comment: For all examples it's assumed that the included Gtk binaries will be stored into "C:\Python27\Lib\site-packages\gtk" and it's also strongly assumed that this value will be added to the windows environment variable PATH! Checking the state of the pygi-aio package can be done confirmed by:* start starting Python (e. g.: C:\Python27>python)

Python 2.7.3 6 (default, Apr Nov 10 20122013, 2319:3124:2618) [MSC v.1500 32 bit (Intel)] on win 32

>>> from gi.repository import GObjectGtk

(3, 410, 2) ===ICU/PyICU===This new used package is a "must be". 27.02.2013: Download http://dl.dropbox.com/u/81888101/Gramps/PYICU_py27_win32.zip.* Copy all files from PYICU_py27_win32.zip\lib\site-packages to "C:\Python27\Lib\site-packages"* Copy all files from PYICU_py27_win32.zip\bin to folder found by Python / Gramps. In any final version all binaries can be stored in the folder. But for our trials we prefer a separate folder to be independent from other packages: "C:\icu". Because of this decision we have to add the this to the environment variable PATH. To check ICU/PyICU just try it in Python (don't forget the environment variable PATH): Python 2.7.3 (default, Apr 10 2012, 23:31:26) [MSC v.1500 32 bit (Intel)] on win 32 Type "help", "copyright", "credits" or "license" for more information. >>> import icu >>> print icu.ICU_VERSION 50.1.2 >>> print icu.VERSION 1.5

====language-pack-gnome-xx====

The necessary package related to our GTK package will be provided also by the programmer of the GTK package (see above). It's to find in an other distribution package because of the limits of the used repository:* 1119.0301.20132014: from http://code.google.com/p/osspack32/downloads/detail?name=pygi-aio-3.4.2rev10-opt.7z&can=2&q=pygi-aio-3.4.2rev10.7z download pygi-aio-3.4.2rev10-opt.7z * 07.03No further actions necessary, because this GTK package contains also these components.2013 (Deprecated): <strike>From http://code.google.com/p/osspack32/downloads/detail?name=pygi-aio-3.4.2rev8-opt.7z&can=2&q= download pygi-aio-3.4.2rev8-opt.7z</strike>* Deprecated versions before 0711.03.2013 see history  Copy the folder "pygi-aio-3.4.2rev?-opt.7z\gtk\share\locale" into the related Gtk folder "..\site-packages\gtk\share\locale". For our example this would be: "C:\Python27\Lib\site-packages\gtk\share\locale".

====osmgpsmap====

* Used to show maps in the geography view. Without this the GeoView will not be active, see http://gramps-project.org/wiki/index.php?title=[[Gramps_4.0_Wiki_Manual_1_Wiki_Manual_-_Main_Window_Categories#Geography_Category]]

* 1119.0301.20132014: osmgpsmap is integrated part of the GTK3 GTK package. * 07.03.2013 (Deprecated): <strike>From http://code.google.com/p/osspack32/downloads/detail?name=osm-gps-map-git.7z&can=2&q= download osm-gps-map-git.7z. For our example copy the content to "C:\Python27\Lib\site-packages".</strike>

====GExiv2====Is an optional package.19.01.2014: GExiv2 is integrated part of the GTK package.  Because the EditExifMetadata add-on isn't currently available this package is tested for reading exif data only using the "image metadata" gramplet. ====gtkspell====Requirements from README (optional package):* Enable spell checking in the notes. * Gtkspell depends on enchant. * A version of gtkspell with gobject introspection is needed, so minimally version 3.0.0.  19.01.2014: The basics to use a spell are already included in the here used GTK package. {{man warn| At least the content of pygi-aio-3.10.2-win32_rev15-setup.exe used by Gramps forces an crash if libenchant_voikko.dll is available!<br/>It is strongly requested to delete ...\Lib\site-packages\gnome\lib\enchant\libenchant_voikko.dll.}} The only missed things may be special myspell dictionaries (comment: Gramps uses myspell only!) . These can be found here:* from http://extensions.openoffice.org/ download the language packages of your choice. Included in the there provided .oxt files one can extract by using a program like 7-Zip the necessary .aff and .dic files.* alternate [http://extensions.libreoffice.org/extension-center?getCategories=Dictionary&getCompatibility=any extensions.libreoffice.org/]* Or you may find these files (.aff and .dic) as part of any GrampsAIO installation in "..\share\enchant\myspell" For our example all files *.aff *.dic have to be stored into "C:\Python27\Lib\site-packages\gnome\share\enchant\myspell".  TODO ISSUE/WORK There are still some issues using spell (as per 019.01.2014):* Open the note editor having spell activated slows down the os extremely as longer as larger the text. This may cost more than 45 seconds for a text having 400 lines and 17000 characters. So it's strongly suggested to don't global activate "Enable spelling checker" in Preferences!* Up to Gramps 4.0.2 there is a spell related issue [https://www.gramps-project.org/bugs/view.php?id=7339 #7339] which has to be prevented by the there provided patch! ====gir-webkit====Information from README:* GObject introspection data of WebKit is required for the hidden view 'Htmlview', which allows websites to be opened in Gramps. * Users can unhide the view in the plugin manager. * A html renderer must be installed to use the view.* !! PACKAGERS, Test if on your distribution webkit and Gramps is stable. If you obtain crashes, patch src/plugins/view/htmlrenderer.py and src/plugins/view/geoview.gpr.py, so as to remove: from gi.repository import WebKit as webkit  19.01.2014: Webkit is an integrated part of the GTK package. ====goocanvas====Information from README:* Required for the Graphview plugin 19.01.2014: It's is part of the current GTK package === Not Provided by GTK-AIO package === ====ICU/PyICU====Requirements from README (*STRONGLY RECOMMENDED*): 19.01.2014: Download http://dl.dropbox.com/u/81888101/Gramps/PYICU_py27_win32.zip (This zip provides ICU/PyICU version 1.5 (for current version information see https://pypi.python.org/pypi/PyICU ) * Copy all files from PYICU_py27_win32.zip\lib\site-packages to "C:\Python27\Lib\site-packages"* Now we have to place the binaries from PYICU_py27_win32.zip\bin to a folder found by Python / Gramps:** First Option: Somewhere on hard disc e.g. "C:\icu". In this case we have to add this path to the environment variable PATH.** Second Option: Into the same folder as python.exe. That's a good solution for a package, because we don't need any changes for the environment variable PATH. ''If you don't know, where to put dll (you get an "ImportError: DLL load failed" error), put a *.dll in a "C:\Python27\Lib\site-packages" (without a bin subfolder).'' To check ICU/PyICU just try it in Python (don't forget the environment variable PATH): Python 2.7.6 (default, Nov 10 2013, 19:24:18) [MSC v.1500 32 bit (Intel)] on win 32 Type "help", "copyright", "credits" or "license" for more information. >>> import icu >>> print icu.ICU_VERSION 50.1.2 >>> print icu.VERSION 1.5 Comment (19.01.2014): There are other unofficial PyICU versions available some where in the web. But be careful to use other than the one above. Unexpected issues may be caused. ====GraphViz====

19.01.2014: Following the information on http://www.graphviz.org we get the current installation graphviz-2.30.msi package from http://www.graphviz.org/Download_windows.php and run it: graphviz-2.36.zip

For the examples we used copy the default installation path complete content to "C:\Program Files (x86)\Graphviz2.3036\" and the installation for 'everyone'.

{{man warn| Using "Graph View" GraphViz 2.34 or higher forces an error (#7109). At #7109 you will find a patch to solve the issue.<br>Without this patch and a still unsolved issue one should use graphviz-2.30.1.zip from http://www.graphviz.org/pub/graphviz/stable/windows/. The handling is the same as above}}<br>Comments: GraphViz will be used e. g. for any report in Reports --> Graphs. Without GraphViz there is only one output format "Graphvi File". If all is OK there are several output formats available (e. g. "PDF (Graphviz)", "JPEG image" etc.).

===pyexiv2==='''24[https://www.gramps-project.02org/bugs/view.2013: Will not be used any more, replaced by GExiv2'''php?id=7109 #7109]

===ghostscript ghostview===Optional packages* From alternate http://www.ghostscriptportableapps.com/download/gsdnld.html download the "Ghostscript GPL Release" and run the downloaded file gs907w32.exe. For the example we again use the default installation. Python node/ Gramps needs to know the folder where the binaries are stored (default: "C:\Program Files 38245 '''GVEdit (x86)\gs\gs9.07\bin"Graphviz)* From http://pages.cs.wisc.edu/~ghost/gsview/get50.htm download gsv50w32.exePortable'''

===GExiv2=pyexiv2====Is an optional package'''24.07.0302.2013: Will not be used any more, replaced by [[Run_Gramps40_for_Windows_from_source_using_Python_2.7.3#GExiv2 |GExiv2 is integrated part of the GTK3 package. ]]'''

Because ====ghostscript ghostview====Optional packages* From http://www.ghostscript.com/download/gsdnld.html download the EditExifMetadata add-on isn"Ghostscript GPL Release" for "Ghostscript 9.10 for Windows (32 bit)" and run the downloaded file gs910w32.exe. For the example we again use the default installation. ** Python / Gramps needs to know the folder where the binaries are stored (default: "C:\Program Files (x86)\gs\gs9.10\bin") by defining the environment variable PATH.** As option it't currently available this package is tested for reading exif data only using s possible to place the content of the binary folder (default: "C:\Program Files (x86)\gs\gs9.10\bin") into the same folder as python.exe to prevent any changes of the environment variable PATH.* From http://pages.cs.wisc.edu/~ghost/gsview/get50.htm download and run gsv50w32.exe (e. g. into the default install folder: C:\Program Files (x86)\Ghostgum).** Python / Gramps needs to know the folder where the binaries are stored (default: "image metadataC:\Program Files (x86)\Ghostgum\gsview" gramplet) by defining the environment variable PATH.<br>Comment: This tool will be used to display .ps files as optional result of reports. So at least it's like e.g. any a .pdf viewer or .rtf viewer. It would be possible to include it into any Gramps package. But as normally nobody would include a .pdf viewer or .rtf viewer into a Gramps package I won't suggest to do that for a .ps viewer.** alternate http://portableapps.com/apps/utilities/ghostscript_portable

===gtkspell=rcs====

* Enable spell checking in the notes. * Gtkspell depends on enchant. * A version of gtkspell with gobject introspection is needed, so minimally version 3.0.0. The basics to use a spell are already included in the here used GTK3 package. The only missed things are myspell dictionaries. These can be found:* from [http://wikien.openofficewikipedia.org/wiki/Dictionaries download the language packages of your choice. In some cases (e.g. for German) it's more difficult because one has to download a "OpenOffice.org 3.x Extensions" package. For German one will get via http://extensions.services.openoffice.org/project/dict-de_DE_frami the file dict-de_DE-frami_2012-06-17.oxt. Using a program like 7-Zip one will find the necessary files (de_DE_frami.aff and de_DE_frami.dic) in "dict-de_DE-frami_2012-06-17.oxt\de_DE_frami\". * from e.g. the GrampsAOI3.4.2 package in "..\GrampsAIO32_3.4.2\share\enchant\myspell" For our example all files *.aff *.dic have to be stored into "C:\Python27\Lib\site-packages\gtk\share\enchant\myspell". TODO ISSUE/WORK There are still some issues using spell:* Open the note editor having spell activated slows down the os extremely as longer as larger the text.* The spell settings will not be stored. ===rcs===Requirements from README (optional package):* The Revision_Control_System GNU Revision Control System (RCS) ] can be used to manage multiple revisions of your family trees. * See info at http://www.gramps-project.org/wiki/index.php?title=[[Gramps_4.0_Wiki_Manual_1_Wiki_Manual_-_Manage_Family_Trees#Archiving_a_Family_Tree]]

====PIL====

* alternate: http://python-pillow.github.io/ ====ttf-freefont====

07.03.2013 TODO WORK: How to use for the Windows environment. It's assumed that the fonts should be added to the Graphviz environment, but not yet tested.  ===gir-webkit===Information from README:* GObject introspection data of WebKit is required for the hidden view 'Htmlview', which allows websites to be opened in Gramps. * Users can unhide the view in the plugin manager. * A html renderer must be installed to use the view.* !! PACKAGERS, Test if on your distribution webkit and Gramps is stable. If you obtain crashes, patch src/plugins/view/htmlrenderer.py and src/plugins/view/geoview.gpr.py, so as to remove: from gi.repository import WebKit as webkit 

==Start Gramps 4.0.x==

For all examples it's assumed that the Gramps source (e.g. from the GIT repository http://svngit.code.sf.net/p/gramps/codesource/ or the .tar.gz from from http://sourceforge.net/projects/gramps/files/branchesStable/maintenance../gramps40) will be stored into "C:\Gramps4.0".

It's helpful to use a Subversion special client for Windows to get these sources. Also if one gets sources only such a tool provides the possibility of history search and or compare and also to mark differences between the current version on the computer and the repository.

There are good experiences using TortoiseSVN TortoiseGIT from http://tortoisesvncode.netgoogle.com/p/tortoisegit/downloads.html.

[Changed 03.12.2013]To run setup.py we need the translation tools from tool msgfmt.exe having a proper version. The installer for poedit (http://sourceforge.net/projects/gnuwin32poedit/files/gettextpoedit/0.141.45/gettextpoedit-01.145.47-setup.exe/download?use_mirror=switch&download=: Download gettext-) provides msgfmt.exe in version 0.1418.41.exe and run it to install0.

Latest version of poedit available from https://poedit.net/download For all examples assumed we assume poedit to be installed to: "C:\Program Files (x86)\GnuWin32\binPoedit" (The default path of the installer).

<codepre> C: cd C:\Gramps4.0 set path=C:\Python27;C:\Program Files (x86)\GnuWin32Poedit\bin;%path% C:\Program Files (x86)\Graphviz2.30Poedit\GettextTools\bin;%path% C:\Python27\python setup.py build pause </codepre> 

* 0319.0301.2013 (Deprecated)2014: <strike>27.02.2013: Using LANG To get the license information within the Help-About dialogue one has to force copy the file COPYING from the Gramps to use an other language than English runs at least for LANG=de_DE into an error sources root (see [http://wwwe.gramps-projectg.org/bugs/viewC:\Gramps4.php?id=6481 6481]0)into the to be generated folder </strikegramps root>* 03\build\data (e.03g.2013 (Deprecated): <strike>Currently there is an issue between setup.py and the code using the content of const.py that's why we need manually changes in ""C:\Gramps4.0\gramps\gen\const.py, line 203 to 206: In all string paths for LOCALE_DIR , DATA_DIR, IMAGE_DIR, DOC_DIR replace '\' by 'build\\'</strike>* 23.02.2013 (Deprecateddata): <strike>16.02.2013: see also above how to install the Gtk package. As described in issue 6429 [http://www.gramps-project.org/bugs/view.php?id=6429] there is a work around to have the drop down menu for gramplets in the side and bottom bar working: new "Gdk-3.0.typelib" from this issue page (TODO ISSUE: to be removed if the new typelib is part of the package)</strike>

* For our example theme packages have to be stored in "C:\Python27\Lib\site-packages\gtkgnome\share\themes". Per default with the here used GTK package there are three packages available:

* C:\Python27\Lib\site-packages\gtkgnome\etc\gtk-3.0\settings.ini

gtk-theme-name = AdwaitaHighContrast

Because we didn't add all packages suggested by the README we didn't have the full functionality. Especially some output formats and the geographic view are not available yet (TODO WORK: Add the missing packages having a usable version.)

Because For Gramps 4.0 is still under 1 development there are may still several be issues and crashes etc (see bug tracker: http://www.gramps-project.org/bugs/view_all_bug_page.php). It's strongly recommended to use test data for validation only!

<codepre> set LANG=en_GBde_DE

@rem may be some time we need an other language @rem set LANG=de_DE

@rem it's a good idea to have a own GRAMPSHOME set GRAMPSHOME=C:\Gramps40 @rem we need the path of the Gtk binaries set path=C:\Goocanvas;C:\Program Files (x86)\gs\gs9.0710\bin;C:\icu;C:\Python27\lib\site-packages\gtk;%path%;C:\Program Files (x86)\Graphviz2.3036\bin

@rem let's jump to Python binaries C: cd C:\Python27

@rem call for all version information (e.g. as background for any issue) python "C:\Gramps4.0\gramps.py" -v

@rem let's start Gramps python "C:\Gramps4.0\gramps.py" pause </codepre>

"Gramps -v" should show this information now (last change 03if one uses the gramps-4.030.2013)2.tar.gz from http://sourceforge.net/projects/gramps/files/Stable/:

python : 2.7.36 gramps : 4.0.0-alpha5-r21574M2 gtk++ : 3.10.6.4 pygobject : 3.410.2 pango : 1.3236.61

bsddb : 45.83.4.20

cairo : 1.12.1016

osmgpsmap : 1.0.8

Graphviz : 2.3036 Ghostscr. : 9.0710

C:\Program Files (x86)\gs\gs9.0710\bin