GRASS-Wiki - User contributions [en]

Packaging on MacOSX

2009-09-22T14:00:46Z

⚠️Kyngchaos: /* wxPython */ 6.4/6.5 differences

{{MoveToTrac}}
Notes on packaging GRASS for distribution on Mac OS X. This applies to the Mac OS X application build (<code>--enable-macosx-app</code>) only.

The OSX app build includes its own bindist make target, which creates an OSX installer package (instead of the tarball + script that the unix build bindist creates).

== bundling ==

There is also a bundle.make makefile fragment that is included in the main OSX makefile that is customizable to bundle dependencies and helpers into the application package, to make the app more portable to other OSX systems (so the user doesn't have to install them themselves). See bundle.make comments for details on install commands and destination paths.

A couple examples are included in bundle.make. Here are more.

=== wxPython ===

wxPython is a good one to bundle, because a python module may directly link a wx library, and the binary distribution of wxPython uses a different path for each version, ''and'' the installer will destroy previous versions. ie:

/usr/local/lib/wxPython-unicode-2.8.10.1/lib

There are a couple different parts to copy. Plus, the GRASS startup script needs one change (this is done by the additions to bundle.make). In bundle.make, first, add this before the <tt>bundle-macosx:</tt> line (change the wx version to match what you have installed):

WXPREFIX=/usr/local/lib/wxPython-unicode-2.8.10.1

Then in the <tt>bundle-macosx:</tt> section (make sure to indent all lines with <tt><tabs></tt>), you may need to change the library versions to match what you have installed:

<pre>
${INSTALL} ${WXPREFIX}/lib/libwx_macud-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gl-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_stc-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gizmos-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gizmos_xrc-2.8.0.dylib ${INST_DIR_TARGET}/lib
cp -Rfp ${WXPREFIX}/lib/python2.5/site-packages/wx-2.8-mac-unicode/wx ${INST_DIR_TARGET}/etc/python
cp -Rfp ${WXPREFIX}/lib/python2.5/site-packages/wx-2.8-mac-unicode/wxPython ${INST_DIR_TARGET}/etc/python
cp -fp ${WXPREFIX}/lib/python2.5/site-packages/wxversion.py ${INST_DIR_TARGET}/etc/python
sed -i '' -e 's/^GRASS_WXBUNDLED=.*/GRASS_WXBUNDLED=1/' ${INST_DIR_TARGET}/grass.sh
</pre>

This applies to GRASS 6.5 and 7. For GRASS 6.4, change all <tt>INST_DIR_TARGET</tt> to <tt>MACOSX_BUNDLE_PREFIX</tt> above.

Note: wxPython's version checking doesn't work in a bundled environment, so the <tt>GRASS_WXBUNDLED</tt> flag is set in the startup script (that's what the sed line above does) to tell the GUI startup to skip the wx version check.

Packaging on MacOSX

2009-09-21T03:50:50Z

⚠️Kyngchaos: /* wxPython */ correct install variable, clarify steps

{{MoveToTrac}}
Notes on packaging GRASS for distribution on Mac OS X. This applies to the Mac OS X application build (<code>--enable-macosx-app</code>) only.

The OSX app build includes its own bindist make target, which creates an OSX installer package (instead of the tarball + script that the unix build bindist creates).

== bundling ==

There is also a bundle.make makefile fragment that is included in the main OSX makefile that is customizable to bundle dependencies and helpers into the application package, to make the app more portable to other OSX systems (so the user doesn't have to install them themselves). See bundle.make comments for details on install commands and destination paths.

A couple examples are included in bundle.make. Here are more.

=== wxPython ===

wxPython is a good one to bundle, because a python module may directly link a wx library, and the binary distribution of wxPython uses a different path for each version, ''and'' the installer will destroy previous versions. ie:

/usr/local/lib/wxPython-unicode-2.8.10.1/lib

There are a couple different parts to copy. Plus, the GRASS startup script needs one change (this is done by the additions to bundle.make). In bundle.make, first, add this before the <tt>bundle-macosx:</tt> line (change the wx version to match what you have installed):

WXPREFIX=/usr/local/lib/wxPython-unicode-2.8.10.1

Then in the <tt>bundle-macosx:</tt> section (make sure to indent all lines with <tt><tabs></tt>), you may need to change the library versions to match what you have installed:

<pre>
${INSTALL} ${WXPREFIX}/lib/libwx_macud-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gl-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_stc-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gizmos-2.8.0.dylib ${INST_DIR_TARGET}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gizmos_xrc-2.8.0.dylib ${INST_DIR_TARGET}/lib
cp -Rfp ${WXPREFIX}/lib/python2.5/site-packages/wx-2.8-mac-unicode/wx ${INST_DIR_TARGET}/etc/python
cp -Rfp ${WXPREFIX}/lib/python2.5/site-packages/wx-2.8-mac-unicode/wxPython ${INST_DIR_TARGET}/etc/python
cp -fp ${WXPREFIX}/lib/python2.5/site-packages/wxversion.py ${INST_DIR_TARGET}/etc/python
sed -i '' -e 's/^GRASS_WXBUNDLED=.*/GRASS_WXBUNDLED=1/' ${INST_DIR_TARGET}/grass.sh
</pre>

Note: wxPython's version checking doesn't work in a bundled environment, so the <tt>GRASS_WXBUNDLED</tt> flag is set in the startup script (that's what the sed line above does) to tell the GUI startup to skip the wx version check.

Packaging on MacOSX

2009-06-15T14:03:05Z

⚠️Kyngchaos:

Notes on packaging GRASS for distribution on Mac OS X. This applies to the Mac OS X application build (<code>--enable-macosx-app</code>) only.

The OSX app build includes its own bindist make target, which creates an OSX installer package (instead of the tarball + script that the unix build bindist creates).

== bundling ==

There is also a bundle.make makefile fragment that is included in the main OSX makefile that is customizable to bundle dependencies and helpers into the application package, to make the app more portable to other OSX systems (so the user doesn't have to install them themselves). See bundle.make comments for details on install commands and destination paths.

A couple examples are included in bundle.make. Here are more.

=== wxPython ===

wxPython is a good one to bundle, because a python module may directly link a wx library, and the binary distribution of wxPython uses a different path for each version, ''and'' the installer will destroy previous versions. ie:

/usr/local/lib/wxPython-unicode-2.8.10.1/lib

There a couple different parts to copy, plus the GRASS startup script needs one change. In bundle.make, first, add this before the <tt>bundle-macosx:</tt> line (change the wx version to match what you have installed):

WXPREFIX=/usr/local/lib/wxPython-unicode-2.8.10.1

Then in the <tt>bundle-macosx:</tt> section (make sure to indent all lines with <tt><tabs></tt>), you may need to change the library versions to match what you have installed:

<pre>
${INSTALL} ${WXPREFIX}/lib/libwx_macud-2.8.0.dylib ${MACOSX_BUNDLE_PREFIX}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gl-2.8.0.dylib ${MACOSX_BUNDLE_PREFIX}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_stc-2.8.0.dylib ${MACOSX_BUNDLE_PREFIX}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gizmos-2.8.0.dylib ${MACOSX_BUNDLE_PREFIX}/lib
${INSTALL} ${WXPREFIX}/lib/libwx_macud_gizmos_xrc-2.8.0.dylib ${MACOSX_BUNDLE_PREFIX}/lib
cp -Rfp ${WXPREFIX}/lib/python2.5/site-packages/wx-2.8-mac-unicode/wx ${MACOSX_BUNDLE_PREFIX}/etc/wxpython
cp -Rfp ${WXPREFIX}/lib/python2.5/site-packages/wx-2.8-mac-unicode/wxPython ${MACOSX_BUNDLE_PREFIX}/etc/wxpython
${INSTALL_DATA} ${WXPREFIX}/lib/python2.5/site-packages/wxversion.py ${MACOSX_BUNDLE_PREFIX}/etc/wxpython
sed -i '' -e 's/^GRASS_WXBUNDLED=.*/GRASS_WXBUNDLED=1/' ${MACOSX_BUNDLE_PREFIX}/grass.sh
</pre>

wxPython's version checking doesn't work in a bundled environment, so the <tt>GRASS_WXBUNDLED</tt> flag is set in the startup script to tell the GUI startup to skip the wx version check.

Packaging on MacOSX

2009-06-12T22:40:39Z

⚠️Kyngchaos: created

Notes on packaging GRASS for distribution on Mac OS X.

todo

Compile and Install

2009-06-12T22:38:11Z

⚠️Kyngchaos: /* Mac OSX */ packaging

== How to do compilation and installation of GRASS 6? ==

Here we explain the procedure to compile GRASS from SVN, but it also applies to official GRASS 6 releases.

''For installation of precompiled binary packages, see the main [[Installation Guide]].''

For detailed information on compilation, please see the [http://grass.itc.it/grass61/source/INSTALL INSTALL] file in the source code.

=== Prerequisites ===

GRASS needs at least two extra libraries: PROJ and GDAL/OGR

''Note: if you want to have DBMS support in GDAL (subsequently in GRASS) you have to perform the "Optional" steps below as well.''

* [http://proj.maptools.org PROJ4] for management of projections (with proj-datumgrid-1.3.zip support)
* Optional: [http://geos.refractions.net GEOS]
* Optional: [http://www.postgresql.org PostgreSQL], [http://www.mysql.org mySQL], [http://www.unixodbc.org unixODBC], [http://www.sqlite.org SQLite] (SQLite is needed for QGIS)
* [http://www.gdal.org GDAL/OGR] for reading and writing various GIS data formats (interoperability)

You have to install these two libraries '''first'''.

It is easiest to obtain a prepackaged version of these libraries (e.g., .rpm; .deb) for your particular operating system and run the corresponding package installation (e.g., rpm -Uhv packagename.rpm; apt-get) in a terminal window. Take care to also install the development packages of these libraries (...-devel packages). If there is no prepackage version, then you will have to download the source code (see links above, source code packages usually ends in .tar.gz or .zip) and compile it (you must have a C compiler installed as part of your operating system). The Web sites show the steps to compile the libraries.

Other libraries needed to run GRASS are listed on the {{website|grass64/source/REQUIREMENTS.html|requirements page}}.

To compile, you will also need the respective "-devel" packages.

=== Generic Compilation and installation procedure ===

* It is wise that compilation processes are carried out as a normal user: If you want to get the source code in a place where you do not have write permissions (e.g. in /usr/local/src/) just follow this:
cd /usr/local/src/
su -c 'mkdir grass6'
su -c 'chown yourlogin:yourgroup grass6'

Otherwise if you have permissions just continue as a normal user:
cd /usr/local/src/
svn checkout ...

* do a code checkout from the SVN source code repository
: checkout the latest GRASS 6.x from SVN (see: {{twiki|DownloadSource}})

* in the grass6 directory, you will find the precious INSTALL file, open it with your favourite pager/editor and read it carefully!

* run configure with parameters to adapt the compile process to your own system. To see what options can be passed to it, run configure --help.

It may (!) look like this:

./configure \
--with-cxx \
--with-sqlite \
--with-postgres-libs=/usr/include/pgsql/libpq \
--with-postgres-includes=/usr/include/pgsql \
--with-freetype \
--with-freetype-includes=/usr/include/freetype2 \
--with-motif \
--with-proj-share=/usr/share/proj

You may have to explicitly state the path for certain packages (i.e., gdal). The Unix 'locate' command will come in handy for finding the path of the package you need (you may have to run locate as root ex: sudo locate gdal-config).

Please note that the paths mentioned may widely vary due to the distribution used.
See [[Compile_and_Install#Platform_Specific_Notes|Platform Specific Notes]] below.

Depending on your needs it may be a good idea to include debugging hooks.
: See [[GRASS_Debugging#Compile_Time_Setup]].
CFLAGS="-ggdb -Wall -Werror-implicit-function-declaration" ./configure ...

At the end of configuration process you should get report not much different from this:

GRASS is now configured for: i686-pc-linux-gnu

Source directory: /usr/src/grass6
Build directory: /usr/src/grass6
Installation directory: /usr/local/grass-6.3.svn
Startup script in directory: ${exec_prefix}/bin
C compiler: gcc -g -O2
C++ compiler: c++ -g -O2
FORTRAN compiler:
Building shared libraries: yes
64bit support: no

NVIZ: yes

BLAS support: no
C++ support: yes
DWG support: no
FFMPEG support: no
FFTW support: yes
FreeType support: yes
GDAL support: yes
GLw support: no
JPEG support: yes
LAPACK support: no
Large File Support (LFS): no
Motif support: no
MySQL support: no
NLS support: no
ODBC support: no
OGR support: yes
OpenGL(R) support: yes
PNG support: yes
PostgreSQL support: yes
Readline support: no
SQLite support: no
Tcl/Tk support: yes
TIFF support: yes
X11 support: yes

* Let's compile it (takes a little while...)!
make
* At the end, you should get report not much different from this:
----------------------------------------------------------------------
Following modules are missing the 'description.html' file in src code:
----------------------------------------------------------------------
GRASS GIS compilation log
-------------------------
Started compilation: Ne kvě 28 13:18:43 CEST 2006
--
Errors in:
--
Finished compilation: Ne kvě 28 13:43:40 CEST 2006
(In case of errors please change into the directory with error and run 'make')

* If there is any error, change directory to directory with error and run "make" again. Report occuring bug to grass mailing list
* Once the installation process is finished, you're ready to install GRASS system wide.
su -c 'make install'
* enjoy GRASS:
grass63

=== What else? ===

If you want to use [http://www.qgis.org QGIS], then also compile the GRASS-GDAL/OGR plugin. This is also useful to access your GRASS-data
from other application using GDAL/OGR like [http://thuban.intevation.de thuban].
* [[Compile and install GRASS and QGIS with GDAL/OGR Plugin]] (enables QGIS to read GRASS data directly)

=== Platform Specific Notes ===

==== Linux ====

===== Debian =====

Read the instructions here:
: http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/debian/README.debian

# first install PROJ, then GDAL.
cd grass64/
# follow instructions in debian/README.debian
fakeroot buildpackage

* Official [http://wiki.debian.org/DebianGis DebianGIS] packaging [http://svn.debian.org/viewsvn/pkg-grass/packages/grass/ control files], also accessible via svn:
svn co svn://svn.debian.org/svn/pkg-grass/packages/grass/trunk/
or
svn co svn://svn.debian.org/svn/pkg-grass/packages/grass/branches/<GRASS Version>

* [http://hamish.bowman.googlepages.com/debiangisfiles#compile Compiling GRASS 6.1-CVS on Debian/OldStable (aka 3.1, Sarge)]

===== Ubuntu =====

''The above Debian notes will probably work with Ubuntu as well.''

A more [[Compile_and_Install_Ubuntu | specific page]] towards Ubuntu is being written on.

====== Ubuntu 6.06, 7.10 ======

* [http://david.p.finlayson.googlepages.com/makegrass.sh makegrass.sh] is script designed to automate most of the download, configuration and compilation of GRASS 6.x-CVS
** it is advised use [https://help.ubuntu.com/community/CheckInstall checkinstall] (''sudo apt-get install checkinstall'') instead of ''make install'' to keep track of installed software
** Think twice before using this script. Some users experienced problems such as disabled XGL etc.
* [[User:Steko/Automated_CVS_compiling|Here]] is another of these scripts, it's homemade so probably you'll find the above more useful for production sites.

====== Ubuntu 7.10 64-bit ======

* Compiling latest GRASS source code on a 64-bit machine (with an ATI graphic card) under Ubuntu 7.10 64-bit with support for: 64-bit, SQLite, OpenGL, PYTHON, FFMPEG
(Based on "Ubuntu 6.06 LTS - GRASS 6.1 Compilation Script" by David Finlayson)
''Assuming it is the first time attempting to compile GRASS' source code & installing SVN, PROJ, GDAL/OGR''

'''Preparation'''
sudo apt-get update && sudo apt-get upgrade

* install dependencies for compiling (in general) and dependencies for GRASS: PROJ, GDAL/OGR
sudo apt-get install grass build-essential flex bison libncurses5-dev zlib1g-dev \
libjpeg62-dev libgdal1-dev libtiff4-dev libgcc1 libpng12-dev tcl8.4-dev tk8.4-dev fftw3-dev \
libfreetype6-dev libavcodec-dev libxmu-dev gdal-bin libreadline5 libreadline5-dev \
make python-dev python-wxversion swig

* install SQLite
sudo apt-get install sqlite3 libsqlite3-dev

* install SVN
sudo apt-get install subversion

* create a directory as a simple user where source code(s) are going to be stored (in our example we use a directory called '''src''' under '''/usr/local''')

sudo mkdir /usr/local/src

* grant rwx (read-write-execute) permissions for our userid/ groupid on the directory (replace words userid and groupid with real userid):
sudo chown ''userid'':''groupid'' /usr/local/src

sudo chmod ug+rwx /usr/local/src

* download latest source code from GRASS SVN repository in a directory on the system (e.g. /usr/local/src)
svn checkout https://svn.osgeo.org/grass/grass/trunk grass_trunk

* Above command places GRASS' source code in '''/usr/local/src/grass_trunk'''. In case of a subsequent update use the command: '''svn up''' from within the grass_trunk directory

----
'''Before''' attempting to compile GRASS, READ section (C) in the '''INSTALL''' file located in the main directory of GRASS source code entitled:
'''(C) COMPILATION NOTES for 64bit platforms'''
----

* installing FFTW3 if not already on system
sudo apt-get install fftw3 fftw3-dev

====== FFMPEG ======
* install FFMPEG (information taken from: http://stream0.org/2008/01/install-ffmpeg-on-ubuntu-gutsy.html)
* download source code with svn
svn checkout svn://svn.mplayerhq.hu/ffmpeg/trunk ffmpeg

* install dependencies
sudo apt-get install liblame-dev libfaad2-dev libfaac-dev libxvidcore4-dev \
liba52-0.7.4 liba52-0.7.4-dev libx264-dev libdts-dev checkinstall \
build-essential subversion

* guide to ffmpeg directory
cd ffmpeg

if necessary: '''make distclean''' before configuration (look at notes below)

* configuration ('''note:''' the configuration parameter "'''--enable-pp'''" does not work anymore)
# configure FFMPEG
./configure --enable-gpl --enable-libvorbis --enable-libtheora \
--enable-liba52 --enable-libdc1394 --enable-libgsm \
--enable-libmp3lame --enable-libfaad --enable-libfaac \
--enable-libxvid --enable-pthreads --enable-libx264 \
--enable-shared

* compilation
make

* installation on /usr/local/bin -- important to remember when configuring GRASS' source code for compilation
sudo checkinstall

====== '''go for GRASS!''' ======
* in our example we used the /usr/local/src directory to store GRASS' source code, so:
cd /usr/local/src/grass_trunk

* configuration
CFLAGS="-g -Wall" ./configure --enable-64bit \
--with-libs=/usr/lib64 --with-cxx --with-freetype=yes \
--with-postgres=no --with-sqlite=yes --enable-largefile=yes \
--with-tcltk-includes=/usr/include/tcl8.4 \
--with-freetype-includes=/usr/include/freetype2 \
--with-opengl-libs=/usr/include/GL --with-readline \
--with-python=yes --with-ffmpeg=yes \
--with-ffmpeg-includes=/usr/local/include/ffmpeg

*if OpenGL fails then maybe it is necessary to link '''glxATI.h''' with '''glx.h''' and re-run the configuration

cd /usr/include/GL

sudo ln glxATI.h glx.h

* compilation
make

* compilation is expected to end with a statement similar to the following:

Started compilation: Wed Feb 27 00:24:36 CET 2008
--
Errors in:
No errors detected.

* installation
sudo checkinstall

* launch 64-bit GRASS.6.4.svn
grass64

'''Notes'''
* in case of errors in future compilation attempts, remember to remove program binaries with
make clean
* and the files created with the "configuration" from previous compilations with
make distclean

===== Mandriva =====

Installation of dependencies (urpmi will ask you a few more):

# as root
urpmi flex bison zlib-devel tiff-devel png-devel tcl-devel tk-devel sqlite3-devel \
mesagl1-devel mesaglu1-devel libxmu6-devel gcc-c++ swig gettext \
lib64wxgtk2.8 lib64wxgtk2.8-devel lib64wxgtkgl2.8 wxgtk2.8 \
lib64wxPythonGTK2.8 lib64wxPythonGTK2.8-devel wxPythonGTK wxPythonGTK-wxversion
exit

Then (64 bit stuff optional of course):
# as user
./configure \
--enable-64bit --with-libs=/usr/lib64 \
--with-cxx \
--with-gdal=/usr/local/bin/gdal-config \
--with-sqlite \
--with-nls \
--with-python \
--with-wxwidgets=/usr/lib/wxPython/bin/wx-config \
--with-fftw \
--with-ffmpeg --with-ffmpeg-includes="/usr/include/libav* /usr/include/libpostproc /usr/include/libswscale" \
--with-motif \
--with-mysql --with-mysql-includes=/usr/include/mysql --with-mysql-libs=/usr/lib64 \
--with-freetype --with-freetype-includes=/usr/include/freetype2 \
--enable-largefile

make

su
# this will install into /usr/local/
make install
exit

===== RPM SPEC files =====

* ... can be found in the source code, rpm/ directory,
* or [http://teodori.org/repository/grass.html openSuSe]
* or [http://grass.itc.it/grass62/binary/linux/fedora_specs/ Fedora]
* or [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/grass/ Mandriva 2008] or [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/grass/current/SPECS/ Mandriva Cooker] (there are also [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/proj/ proj4], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/geos/ geos], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/gdal/ gdal], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/gdal-grass/ gdal-grass-plugin], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/qgis/ qgis] etc)

===== Zaurus =====

... see [http://wiki.debian.org/?GrassGISonZaurus here] for instructions

==== Mac OSX ====

* see the source/macosx readme
* also see [[Compiling on MacOSX]]
* some notes on [[Packaging on MacOSX]]

==== Solaris ====

* ''2008 Oct 15'': see [http://lists.osgeo.org/pipermail/grass-user/2008-October/047093.html this post on the grass mailing list]

===== 10 SPARC/i86pc =====

* get gcc compiler and tools. There are several sources: Solaris Companion CD (SFW pkg, installs in /opt/sfw/), Blastwave ([http://www.blastwave.org], CSW pkg, installs in /opt/csw/) or Sunfreeware ([http://www.sunfreeware.com], SMC pkg, installs in /usr/local/).
Needed Packages from Sunfreeware: SMCbinut, SMCbison, SMCcoreu, SMCfindu, SMCflex, SMCgawk, SMCgcc, SMCgrep, SMCgzip, SMCless, SMClibt, SMClicon, SMCmake, SMCncurs, SMCproj, SMCsed, SMCtar, SMCtcl, SMCtiff, SMCtk, SMCunzip, SMCzlib.

* compile and install fftw-library ([http://www.fftw.org]). You need to re-compile the library with:

./configure --with-pic --enable-shared; make ; make install.

The pre-built packages don't work.

* compile and install gdal library (see documentation of gdal, [http://www.gdal.org]).

* compile and install any additional libraries (e. g. GEOS, [http://geos.refractions.net]).

* set compiler flags and path. e. g.:

# on ultra-sparc machine:
CFLAGS="-O3 -mcpu=v9"
CXXFLAGS="-O3 -mcpu=v9"
PATH="/usr/local/bin:/opt/sfw/bin:/usr/ccs/bin:/usr/bin:/usr/sbin"
export CFLAGS CXXFLAGS PATH

Path has to be changed for the packages (Sunfreeware: /usr/local/bin, Solaris Companion: /opt/sfw/bin, Blastwave: /opt/csw/bin).

* Next configure, e. g.:

./configure --with-postgres-includes=/usr/include/pgsql/ \
--with-postgres-libs=/usr/lib --with-postgres=yes \
--with-includes=/usr/local/include/ncurses

If you use n(ew)curses, you have to include the path /usr/local/include/ncurses.

then:

make
su
make install

If the shared libraries are not found at runtime of the modules, use 'crle' to add the paths of the libraries for the dynamic linker, e. g. as root:

crle -l /lib:/usr/lib:/usr/local/lib:/opt/sfw/lib:/usr/X11/lib

Be careful not to omit a library path, the system may be unusable if you forget the /lib path.

==== MS-Windows ====

===== MS-Windows/Cygwin =====

... see [http://grass.itc.it/platforms/wingrass.html here] (should be moved to the Wiki)

===== MS-Windows/native =====

====== Compile ======

* [http://www.webalice.it/marco.pasetti/grass/BuildFromSource.html GRASS Windows Native Binary Building Guide] (GRASS 6.3.x)
* [http://trac.osgeo.org/grass/wiki/CompileOnWindows GRASS Windows Native Binary Building Guide] (GRASS 6.4.x)
* See/adapt [http://blog.qgis.org/node/124 idea] for unattended install of QGIS (et al) from [http://trac.osgeo.org/osgeo4w/ OSGeo4W] from the QuantumGIS Blog.

See also [[WinGRASS Current Status]] for latest updates.

=== Common problems and solutions ===

During compilation, error can occur if certain packages are not installed. Here a list of problems with solution:

* error: X11/Xlib.h: No such file or directory
** this suggests that you don't have the X headers installed
** Solution: Install the libx11-dev package

=== Optimization ===

GCC and other compilers support [http://gcc.gnu.org/onlinedocs/gcc-4.3.3/gcc/Optimize-Options.html#Optimize-Options optimization]

If you would like to set compiler optimisations, for a possibly faster binary, type (don't enter a ";" anywhere):

CFLAGS=-O ./configure
or,
setenv CFLAGS -O
./configure

whichever works on your shell. Use -O2 instead of -O if your compiler supports this (note: O is the letter, not zero). Using the "gcc" compiler, you can also specify processor specific flags (examples, please suggest better settings to us):

CFLAGS="-mcpu=athlon -O2" # AMD Athlon processor with code optimisations
CFLAGS="-march=amdfam10" # AMD Phenom II X4 64bit processor with gcc >=4.3
CFLAGS="-mcpu=pentium" # Intel Pentium processor
CFLAGS="-mcpu=pentium4" # Intel Pentium4 processor
CFLAGS="-O2 -msse -msse2 -mfpmath=sse -minline-all-stringops" # Intel XEON 64bit processor
CFLAGS="-mtune=nocona -m64 -minline-all-stringops" # Intel Pentium 64bit processor

To find out optional CFLAGS for your platform, enter:
gcc -dumpspecs

See also: http://gcc.gnu.org/

A real fast GRASS version (and small binaries) will be created with LDFLAGS set to "stripping" (but this disables debugging):

CFLAGS="-O2 -mcpu=<cpu_see_above> -Wall" LDFLAGS="-s" ./configure

=== Configure options and their meanings ===

For configure there are many options and some GRASS modules are built only if some options are set. Here are listed common configuration options with short explanation.

* --prefix=/path - Sets path where GRASS will be installed. GRASS will reside in /path/grass-version.
* --enable-largefile - Enables large (>2Gb on 32bit systems) support. For current large file support status look at [[Large File Support]] page.
* --with-cxx - Enables compilation of C++ code. Required for r.terraflow module.
* --with-readline - Enables readline support. If readline is enabled, you can use its history/editing facilities when entering r.mapcalc expressions on stdin.
* --with-glw - Enables GLw support. The GLw library provides OpenGL "canvas" widgets for Athena and Motif.

That switch is unnecessary for normal compilation. It's only
required for r3.showdspf, which isn't normally built; if you
want it, you have build it manually
(e.g. "make -C raster3d/r3.showdspf").
As similar functionality is now provided by NVIZ, r3.showdspf
is deprecated.
r3.showdspf uses the Motif widget (so you also need a
Motif library, e.g. Lesstif or OpenMotif).
[http://grass.itc.it/pipermail/grassuser/2006-December/037475.html Glynn Clements at GRASS-user mailing list]

=== Parallelized compilation on multi-core CPUs ===

You can dramatically accelerate the compilation of the GRASS code with the -j flag of "make" if you have a multi-core CPU system. This determines the maximum number of jobs to have running at once, so cores don't have to sit idle waiting for jobs on other cores to complete. A good rule of thumb for this value is <tt>number_of_cores * 1.5</tt>, but note that setting any higher than the actual number of cores will only affect the timing slightly. For example, on a dual-core processor:
make -j 4



== Addons ==

=== GRASS-GDAL plugin ===

* see [[Compile and install GRASS and QGIS with GDAL/OGR Plugin]]

=== Compiled C modules ===

'''Requirements:'''

Either:
* a binary GRASS package, or
* source code which has been prepared with:
./configure [opionally flags]
make libs

Each of the [[GRASS_AddOns|addon]] modules should come with a Makefile. To compile it, just run:
make MODULE_TOPDIR=/path/to/grass64/

Installation (requires perhaps "sudo"):
make MODULE_TOPDIR=/path/to/grass64/ install

Note: Compiled addons may require a re-compilation if you changed/updated your GRASS standard binaries.

==== If binary comes with a -dev package ====

Nowadays one does not need to the source code, nor compiling GRASS by oneself to be able to add add-ons. On Debian, you can just install the grass-dev package and then run:
make MODULE_TOPDIR=/usr/lib/grass64/

The grass-dev package essentially provides GRASS's <tt>include</tt> header files and Make configuration files.

=== Scripts ===

If the addon module is a script, it is sufficient to copy it into the (GRASS binaries) path somewhere. Alternatively, install addons into a separate GRASS addons binaries/scripts directory which is easier to maintain. It avoids getting clobbered every time you reinstall GRASS. To use these separately stored scripts, set and export the GRASS_ADDON_PATH environment variable before starting GRASS and it will automatically be added to the module search path (see the {{cmd|variables}} help page). To simplify this, do for example:

# add in $HOME/.bashrc:
GRASS_ADDON_PATH=/usr/local/grass/addons/
export GRASS_ADDON_PATH

[[Category:Development]]
[[Category:Documentation]]
[[Category:Installation]]

Compile and Install

2009-03-12T04:59:48Z

⚠️Kyngchaos: OSX - drop link to old platform notes page

== How to do compilation and installation of GRASS 6? ==

Here we explain the procedure to compile GRASS from SVN, but it also applies to official GRASS 6 releases.

''For installation of precompiled binary packages, see the main [[Installation Guide]].''

For detailed information on compilation, please see the [http://grass.itc.it/grass61/source/INSTALL INSTALL] file in the source code.

=== Prerequisites ===

GRASS needs at least two extra libraries: PROJ and GDAL/OGR

''Note: if you want to have DBMS support in GDAL (subsequently in GRASS) you have to perform the "Optional" steps below as well.''

* [http://proj.maptools.org PROJ4] for management of projections (with proj-datumgrid-1.3.zip support)
* Optional: [http://geos.refractions.net GEOS]
* Optional: [http://www.postgresql.org PostgreSQL], [http://www.mysql.org mySQL], [http://www.unixodbc.org unixODBC], [http://www.sqlite.org SQLite] (SQLite is needed for QGIS)
* [http://www.gdal.org GDAL/OGR] for reading and writing various GIS data formats (interoperability)

You have to install these two libraries '''first'''.

It is easiest to obtain a prepackaged version of these libraries (e.g., .rpm; .deb) for your particular operating system and run the corresponding package installation (e.g., rpm -Uhv packagename.rpm; apt-get) in a terminal window. Take care to also install the development packages of these libraries (...-devel packages). If there is no prepackage version, then you will have to download the source code (see links above, source code packages usually ends in .tar.gz or .zip) and compile it (you must have a C compiler installed as part of your operating system). The Web sites show the steps to compile the libraries.

Other libraries needed to run GRASS are listed on the {{website|grass64/source/REQUIREMENTS.html|requirements page}}.

To compile, you will also need the respective "-devel" packages.

=== Generic Compilation and installation procedure ===

* It is wise that compilation processes are carried out as a normal user: If you want to get the source code in a place where you do not have write permissions (e.g. in /usr/local/src/) just follow this:
cd /usr/local/src/
su -c 'mkdir grass6'
su -c 'chown yourlogin:yourgroup grass6'

Otherwise if you have permissions just continue as a normal user:
cd /usr/local/src/
svn checkout ...

* do a code checkout from the SVN source code repository
: checkout the latest GRASS 6.x from SVN (see: {{twiki|DownloadSource}})

* in the grass6 directory, you will find the precious INSTALL file, open it with your favourite pager/editor and read it carefully!

* run configure with parameters to adapt the compile process to your own system. To see what options can be passed to it, run configure --help.

It may (!) look like this:

./configure \
--with-cxx \
--with-sqlite \
--with-postgres-libs=/usr/include/pgsql/libpq \
--with-postgres-includes=/usr/include/pgsql \
--with-freetype \
--with-freetype-includes=/usr/include/freetype2 \
--with-motif \
--with-proj-share=/usr/share/proj

You may have to explicitly state the path for certain packages (i.e., gdal). The Unix 'locate' command will come in handy for finding the path of the package you need (you may have to run locate as root ex: sudo locate gdal-config).

Please note that the paths mentioned may widely vary due to the distribution used.
See [[Compile_and_Install#Platform_Specific_Notes|Platform Specific Notes]] below.

Depending on your needs it may be a good idea to include debugging hooks.
: See [[GRASS_Debugging#Compile_Time_Setup]].
CFLAGS="-ggdb -Wall -Werror-implicit-function-declaration" ./configure ...

At the end of configuration process you should get report not much different from this:

GRASS is now configured for: i686-pc-linux-gnu

Source directory: /usr/src/grass6
Build directory: /usr/src/grass6
Installation directory: /usr/local/grass-6.3.svn
Startup script in directory: ${exec_prefix}/bin
C compiler: gcc -g -O2
C++ compiler: c++ -g -O2
FORTRAN compiler:
Building shared libraries: yes
64bit support: no

NVIZ: yes

BLAS support: no
C++ support: yes
DWG support: no
FFMPEG support: no
FFTW support: yes
FreeType support: yes
GDAL support: yes
GLw support: no
JPEG support: yes
LAPACK support: no
Large File Support (LFS): no
Motif support: no
MySQL support: no
NLS support: no
ODBC support: no
OGR support: yes
OpenGL(R) support: yes
PNG support: yes
PostgreSQL support: yes
Readline support: no
SQLite support: no
Tcl/Tk support: yes
TIFF support: yes
X11 support: yes

* Let's compile it (takes a little while...)!
make
* At the end, you should get report not much different from this:
----------------------------------------------------------------------
Following modules are missing the 'description.html' file in src code:
----------------------------------------------------------------------
GRASS GIS compilation log
-------------------------
Started compilation: Ne kvě 28 13:18:43 CEST 2006
--
Errors in:
--
Finished compilation: Ne kvě 28 13:43:40 CEST 2006
(In case of errors please change into the directory with error and run 'make')

* If there is any error, change directory to directory with error and run "make" again. Report occuring bug to grass mailing list
* Once the installation process is finished, you're ready to install GRASS system wide.
su -c 'make install'
* enjoy GRASS:
grass63

=== What else? ===

If you want to use [http://www.qgis.org QGIS], then also compile the GRASS-GDAL/OGR plugin. This is also useful to access your GRASS-data
from other application using GDAL/OGR like [http://thuban.intevation.de thuban].
* [[Compile and install GRASS and QGIS with GDAL/OGR Plugin]] (enables QGIS to read GRASS data directly)

=== Platform Specific Notes ===

==== Linux ====

===== Debian =====

# first install PROJ, then GDAL.
cd grass63/
# follow instructions in debian/README.debian
fakeroot buildpackage

* Official [http://pkg-grass.alioth.debian.org/cgi-bin/wiki.pl DebianGIS] packaging [http://svn.debian.org/wsvn/pkg-grass/packages/grass/branches/ control files], also accessible via svn:
svn co svn://svn.debian.org/svn/pkg-grass/packages/grass/branches/<GRASS Version>

* [http://hamish.bowman.googlepages.com/debiangisfiles#compile Compiling GRASS 6.1-CVS on Debian/OldStable (aka 3.1, Sarge)]

===== Ubuntu =====

''The above Debian notes will probably work with Ubuntu as well.''

====== Ubuntu 6.06, 7.10 ======

* [http://david.p.finlayson.googlepages.com/makegrass.sh makegrass.sh] is script designed to automate most of the download, configuration and compilation of GRASS 6.x-CVS
** it is advised use [https://help.ubuntu.com/community/CheckInstall checkinstall] (''sudo apt-get install checkinstall'') instead of ''make install'' to keep track of installed software
** Think twice before using this script. Some users experienced problems such as disabled XGL etc.
* [[User:Steko/Automated_CVS_compiling|Here]] is another of these scripts, it's homemade so probably you'll find the above more useful for production sites.

====== Ubuntu 7.10 64-bit ======

* Compiling latest GRASS source code on a 64-bit machine (with an ATI graphic card) under Ubuntu 7.10 64-bit with support for: 64-bit, SQLite, OpenGL, PYTHON, FFMPEG
(Based on "Ubuntu 6.06 LTS - GRASS 6.1 Compilation Script" by David Finlayson)
''Assuming it is the first time attempting to compile GRASS' source code & installing SVN, PROJ, GDAL/OGR''

'''Preparation'''
sudo apt-get update && sudo apt-get upgrade

* install dependencies for compiling (in general) and dependencies for GRASS: PROJ, GDAL/OGR
sudo apt-get install grass build-essential flex bison libncurses5-dev zlib1g-dev \
libjpeg62-dev libgdal1-dev libtiff4-dev libgcc1 bpng12-dev tcl8.4-dev tk8.4-dev fftw3-dev \
libfreetype6-dev libavcodec-dev libxmu-dev gdal-bin libreadline5 libreadline5-dev \
make python-dev python-wxversion swig

* install SQLite
sudo apt-get install sqlite3 libsqlite3-dev

* install SVN
sudo apt-get install subversion

* create a directory as a simple user where source code(s) are going to be stored (in our example we use a directory called '''src''' under '''/usr/local''')

sudo mkdir /usr/local/src

* grant rwx (read-write-execute) permissions for our userid/ groupid on the directory (replace words userid and groupid with real userid):
sudo chown ''userid'':''groupid'' /usr/local/src

sudo chmod ug+rwx /usr/local/src

* download latest source code from GRASS SVN repository in a directory on the system (e.g. /usr/local/src)
svn checkout https://svn.osgeo.org/grass/grass/trunk grass_trunk

* Above command places GRASS' source code in '''/usr/local/src/grass_trunk'''. In case of a subsequent update use the command: '''svn up''' from within the grass_trunk directory

----
'''Before''' attempting to compile GRASS, READ section (C) in the '''INSTALL''' file located in the main directory of GRASS source code entitled:
'''(C) COMPILATION NOTES for 64bit platforms'''
----

* installing FFTW3 if not already on system
sudo apt-get install fftw3 fftw3-dev

====== FFMPEG ======
* install FFMPEG (information taken from: http://stream0.org/2008/01/install-ffmpeg-on-ubuntu-gutsy.html)
* download source code with svn
svn checkout svn://svn.mplayerhq.hu/ffmpeg/trunk ffmpeg

* install dependencies
sudo apt-get install liblame-dev libfaad2-dev libfaac-dev libxvidcore4-dev \
liba52-0.7.4 liba52-0.7.4-dev libx264-dev libdts-dev checkinstall \
build-essential subversion

* guide to ffmpeg directory
cd ffmpeg

if necessary: '''make distclean''' before configuration (look at notes below)

* configuration ('''note:''' the configuration parameter "'''--enable-pp'''" does not work anymore)
./configure --enable-gpl --enable-libvorbis --enable-libtheora \
--enable-liba52 --enable-libdc1394 --enable-libgsm \
--enable-libmp3lame --enable-libfaad --enable-libfaac \
--enable-libxvid --enable-pthreads --enable-libx264 \
--enable-shared

* compilation
make

* installation on /usr/local/bin -- important to remember when configuring GRASS' source code for compilation
sudo checkinstall

====== '''go for GRASS!''' ======
* in our example we used the /usr/local/src directory to store GRASS' source code, so:
cd /usr/local/src/grass_trunk

* configuration
CFLAGS="-g -Wall" ./configure --enable-64bit \
--with-libs=/usr/lib64 --with-cxx --with-freetype=yes \
--with-postgres=no --with-sqlite=yes --enable-largefile=yes \
--with-tcltk-includes=/usr/include/tcl8.4 \
--with-freetype-includes=/usr/include/freetype2 \
--with-opengl-libs=/usr/include/GL --with-readline \
--with-python=yes --with-ffmpeg=yes \
--with-ffmpeg-includes=/usr/local/include/ffmpeg

*if OpenGL fails then maybe it is necessary to link '''glxATI.h''' with '''glx.h''' and re-run the configuration

cd /usr/include/GL

sudo ln glxATI.h glx.h

* compilation
make

* compilation is expected to end with a statement similar to the following:

Started compilation: Wed Feb 27 00:24:36 CET 2008
--
Errors in:
No errors detected.

* installation
sudo checkinstall

* launch 64-bit GRASS.6.4.svn
grass64

'''Notes'''
* in case of errors in future compilation attempts, remember to remove program binaries with
make clean
* and the files created with the "configuration" from previous compilations with
make distclean

===== RPM SPEC files =====

* ... can be found in the source code, rpm/ directory,
* or [http://www.gdf-hannover.de/media.php?id=1&lg=en here] (Mandrake, SuSe)
* or [http://teodori.org/repository/grass.html openSuSe]
* or [http://grass.itc.it/grass62/binary/linux/fedora_specs/ Fedora]
* or [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/grass/ Mandriva 2008] or [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/grass/current/SPECS/ Mandriva Cooker] (there are also [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/proj/ proj4], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/geos/ geos], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/gdal/ gdal], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/gdal-grass/ gdal-grass-plugin], [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/qgis/ qgis] etc)

===== Zaurus =====

... see [http://wiki.debian.org/?GrassGISonZaurus here] for instructions

==== Mac OSX ====

... see [[Compiling on MacOSX]]

==== Solaris ====

* ''2008 Oct 15'': see [http://lists.osgeo.org/pipermail/grass-user/2008-October/047093.html this post on the grass mailing list]

===== 10 SPARC/i86pc =====

* get gcc compiler and tools. There are several sources: Solaris Companion CD (SFW pkg, installs in /opt/sfw/), Blastwave ([http://www.blastwave.org], CSW pkg, installs in /opt/csw/) or Sunfreeware ([http://www.sunfreeware.com], SMC pkg, installs in /usr/local/).
Needed Packages from Sunfreeware: SMCbinut, SMCbison, SMCcoreu, SMCfindu, SMCflex, SMCgawk, SMCgcc, SMCgrep, SMCgzip, SMCless, SMClibt, SMClicon, SMCmake, SMCncurs, SMCproj, SMCsed, SMCtar, SMCtcl, SMCtiff, SMCtk, SMCunzip, SMCzlib.

* compile and install fftw-library ([http://www.fftw.org]). You need to re-compile the library with:

./configure --with-pic --enable-shared; make ; make install.

The pre-built packages don't work.

* compile and install gdal library (see documentation of gdal, [http://www.gdal.org]).

* compile and install any additional libraries (e. g. GEOS, [http://geos.refractions.net]).

* set compiler flags and path. e. g.:

# on ultra-sparc machine:
CFLAGS="-O3 -mcpu=v9"
CXXFLAGS="-O3 -mcpu=v9"
PATH="/usr/local/bin:/opt/sfw/bin:/usr/ccs/bin:/usr/bin:/usr/sbin"
export CFLAGS CXXFLAGS PATH

Path has to be changed for the packages (Sunfreeware: /usr/local/bin, Solaris Companion: /opt/sfw/bin, Blastwave: /opt/csw/bin).

* Next configure, e. g.:

./configure --with-postgres-includes=/usr/include/pgsql/ \
--with-postgres-libs=/usr/lib --with-postgres=yes \
--with-includes=/usr/local/include/ncurses

If you use n(ew)curses, you have to include the path /usr/local/include/ncurses.

then:

make
su
make install

If the shared libraries are not found at runtime of the modules, use 'crle' to add the paths of the libraries for the dynamic linker, e. g. as root:

crle -l /lib:/usr/lib:/usr/local/lib:/opt/sfw/lib:/usr/X11/lib

Be careful not to omit a library path, the system may be unusable if you forget the /lib path.

==== MS-Windows ====

===== MS-Windows/Cygwin =====

... see [http://grass.itc.it/platforms/wingrass.html here] (should be moved to the Wiki)

===== MS-Windows/native =====

====== Compile ======
See new [http://www.webalice.it/marco.pasetti/grass/BuildFromSource.html GRASS Windows Native Binary Building Guide]

See also [[WinGRASS Current Status]] for latest updates.

... or see [http://wiki.qgis.org/qgiswiki/BuildingWindowsBinaryOnLinux here incl. QGIS compilation] (with MinGW)

* See/adapt [http://blog.qgis.org/node/124 idea] for unattended install of Qgis (et al) from [http://trac.osgeo.org/osgeo4w/ OsGeo4w] from the QuantumGIS Blog.

=== Common problems and solutions ===

During compilation, error can occur if certain packages are not installed. Here a list of problems with solution:

* error: X11/Xlib.h: No such file or directory
** this suggests that you don't have the X headers installed
** Solution: Install the libx11-dev package

=== Configure options and their meanings ===

For configure there are many options and some GRASS modules are built only if some options are set. Here are listed common configuration options with short explanation.

* --prefix=/path - Sets path where GRASS will be installed. GRASS will reside in /path/grass-version.
* --enable-largefile - Enables large (>2Gb on 32bit systems) support. For current large file support status look at [[Large File Support]] page.
* --with-cxx - Enables compilation of C++ code. Required for r.terraflow module.
* --with-readline - Enables readline support. If readline is enabled, you can use its history/editing facilities when entering r.mapcalc expressions on stdin.
* --with-glw - Enables GLw support. The GLw library provides OpenGL "canvas" widgets for Athena and Motif.

That switch is unnecessary for normal compilation. It's only
required for r3.showdspf, which isn't normally built; if you
want it, you have build it manually
(e.g. "make -C raster3d/r3.showdspf").
As similar functionality is now provided by NVIZ, r3.showdspf
is deprecated.
r3.showdspf uses the Motif widget (so you also need a
Motif library, e.g. Lesstif or OpenMotif).
[http://grass.itc.it/pipermail/grassuser/2006-December/037475.html Glynn Clements at GRASS-user mailing list]

== Addons ==

=== Compiled C modules ===

'''Requirements:'''

Either:
* a binary GRASS package, or
* source code which has been prepared with:
./configure [opionally flags]
make libs

Each of the [[GRASS_AddOns|addon]] modules should come with a Makefile. To compile it, just run:

make MODULE_TOPDIR=/path/to/grass64/

Note: Compiled addons may require a re-compilation if you changed/updated your GRASS standard binaries.

==== If binary comes with a -dev package ====

Nowadays one does not need to the source code, nor compiling GRASS by oneself to be able to add add-ons. On Debian, you can just install the grass-dev package and then run:
make MODULE_TOPDIR=/usr/lib/grass

The grass-dev package essentially provides GRASS's <tt>include</tt> header files and Make configuration files.

=== Scripts ===

If the addon module is a script, it is sufficient to copy it into the (GRASS binaries) path somewhere. Alternatively, install addons into a separate GRASS addons binaries/scripts directory which is easier to maintain. It avoids getting clobbered every time you reinstall GRASS. To use these separately stored scripts, set and export the GRASS_ADDON_PATH environment variable before starting GRASS and it will automatically be added to the module search path (see the {{cmd|variables}} help page). To simplify this, do for example:

# add in $HOME/.bashrc:
GRASS_ADDON_PATH=/usr/local/grass/addons/
export GRASS_ADDON_PATH

[[Category:Development]]
[[Category:Documentation]]
[[Category:Installation]]

Compiling on MacOSX

2009-03-12T04:24:17Z

⚠️Kyngchaos: cleanup; uptodate notes in source

Up-to-date compilation instructions are maintained in the source <tt>macosx/ReadMe.rtf</tt>.
This builds a double-clickable application with "aqua" options where possible (Tcl/Tk, Python, OpenGL,...)
and leaves out obscure X11-only-based features that have newer system-agnostic options (like motif/xganim),
though these newer features may not be quite as fully-featured, yet.
The X11 display system ''is'' included, since it is simple to include and is still quite useful.

The method below is for the older X11-based compilation, and includes the X11 motif-based xganim.

To build Grass from source you can use the frameworks that are on :
http://www.kyngchaos.com/software:frameworks
great thanks to W.Kyngesburye.

After installing all the frameworks you can add some library such "motif" needed by Xganim, using fink or build the source code

Install from source the tcl-tk library : http://www.tcl.tk/software/tcltk/downloadnow84.tml in /usr/local

Postgres can be easily compiled from source.

Download a cvs version http://grass.itc.it/download/index.php

Then configure and make grass cvs :

<pre>
cd /path_to_grass_source

./configure --enable-sysv --with-x --with-opengl=x11 --without-odbc --with-cxx --with-freetype \
--with-freetype-includes=/Library/Frameworks/FreeType.framework/unix/include \
--with-freetype-libs=/Library/Frameworks/FreeType.framework/unix/lib \
--with-gdal=/Library/Frameworks/GDAL.framework/Versions/1.5/Programs/gdal-config \
--with-proj-includes=/Library/Frameworks/PROJ.framework/unix/include \
--with-proj-libs=/Library/Frameworks/PROJ.framework/unix/lib \
--with-proj-share=/Library/Frameworks/PROJ.framework/Versions/4.5/unix/share/ \
--with-jpeg --with-jpeg-includes=/Library/Frameworks/UnixImageIO.framework/unix/include \
--with-jpeg-libs=/Library/Frameworks/UnixImageIO.framework/unix/lib \
--with-tiff --with-tiff-includes=/Library/Frameworks/UnixImageIO.framework/unix/include \
--with-tiff-libs=/Library/Frameworks/UnixImageIO.framework/unix/lib \
--with-png-includes=/Library/Frameworks/UnixImageIO.framework/unix/include \
--with-png-libs=/Library/Frameworks/UnixImageIO.framework/unix/lib \
--with-sqlite --with-sqlite-libs=/Library/Frameworks/SQLite3.framework/unix/lib \
--with-sqlite-includes=/Library/Frameworks/SQLite3.framework/unix/include \
--with-fftw --with-fftw-includes=/Library/Frameworks/FFTW3.framework/unix/include \
--with-fftw-libs=/Library/Frameworks/FFTW3.framework/unix/lib \
--with-postgres-includes=/usr/local/pgsql/include --with-postgres-libs=/usr/local/pgsql/lib \
--with-freetype --with-freetype-includes=/Library/Frameworks/FreeType.framework/unix/include \
--with-freetype-libs=/Library/Frameworks/FreeType.framework/unix/lib --with-python --with-readline \
--with-readline-includes=/sw/include/readline --with-readline-libs=/sw/lib --with-tcltk-includes=/usr/local/include \
--with-tcltk-libs=/usr/local/lib --with-blas --with-lapack \
--with-blas-includes=/System/Library/Frameworks/Accelerate.framework/Frameworks/vecLib.framework/Headers \
--with-lapack-includes=/System/Library/Frameworks/Accelerate.framework/Frameworks/vecLib.framework/Headers \
--with-motif --with-motif-includes=/sw/include --with-motif-libs=/sw/lib --with-glw

make
sudo make install
</pre>

Extension development

2007-10-23T03:59:38Z

⚠️Kyngchaos: add makefile notes

= General =

Gather ideas and resources on developing extensions. Especially for installing extensions external to the main GRASS installation.

= Other Pages =

* [[Development GEM]] - Current GEM SVN setup
* [[GRASS 6.3 Feature Plan]] - backreference - hopefully extension compilation can be done for 6.3
* [[GRASS 7 ideas collection#Conceptual Changes|GRASS 7 Conceptual Changes]] - formalizing a user GRASS prefs and addons dir

= Environment variables =

Setting environment variables should be left up to the user or build startup.

Currently, there is a relatively new <code>GRASS_ADDON_ETC</code>. It is a list of paths which point directly to "etc/" directories where an external module can find any support data files or programs it needs (an example is the <code>adinit.dat</code> file needed by '''v.in.dwg'''). It is used by the libgis function G_find_etc(), and the general module '''g.findetc'''.

There is also <code>GRASS_ADDON_PATH</code>, which has been around for many years, and is a list of paths to "bin/" dirs where external modules can be found. This is appended to the shell <code>PATH</code>.

To simplify the possible need for an extension to need any of the standard dirs - bin, include, lib, etc, scripts, docs,... - I suggest a variable having paths point to the common root of those, say <code>GRASS_EXTN_DIR</code>. Then, as necessary, the appropriate subdir would be added. ie init.sh would add */bin to the shell <code>PATH</code> and */lib to <code>[DY]LD_LIBRARY_PATH</code>. This can easily support the $HOME/.grass7 dir idea in the future.

<code>GRASS_ADDON_PATH</code> should be kept for backwards compatibility, and it can still be useful for random user scripts. <code>GRASS_ADDON_ETC</code> should at least be deprecated, if not completely removed - it's a recent CVS addition and I doubt anyone has used it yet.

= Compilation =

In 6.3CVS, the Makefiles are now installed. With a little Makefile cleanup, and a few extra necessary items installled (demolocation and a couple tools), an installed GRASS can support compiling an extension without needing the full GRASS source, and without needing any extra module setup (as is needed currently by GEM-enabled modules). A standard GRASS module Makefile is all the would be needed.

= Makefiles =

Some notes from discussion with Glynn:

* change RUN_GISBASE and RUN_GISRC to be based on ARCH_DISTDIR - this makes it possible to override them for an extension build. Then move them from platform.make.in to grass.make.in, as they are then not configured values.<br/><code>RUN_GISBASE = ${ARCH_DISTDIR}<br/>RUN_GISRC = ${RUN_GISBASE}/demolocation/.grassrc${GRASS_VERSION_MAJOR}${GRASS_VERSION_MINOR}</code>
* move LIB_PREFIX, LIB_SUFFIX and GRASS_LIBRARY_TYPE from grass.make.in to platform.make.in, as they are configured values. Though, leave the version variables, which are configured values, in grass.make.in? Why not put those in platform.make.in, and have grass.make.in -> grass.make - then there is just one configured make fragment, platform.make.in?
* have 2 values in ARCH_INC and ARCH_LIBPATH, based on ARCH_DISTDIR and GISBASE. In a normal build, they are the same. In an extension build, ARCH_DISTDIR is the extension source "staging area" and GISBASE is the installed binary base, and thus will pick up both as needed. There appear to be a few module makefiles that use GISBASE that should be updated to use ARCH_DISTDIR.<br/><code>ARCH_INC = -I$(ARCH_DISTDIR)/include -I$(GISBASE)/include<br/>ARCH_LIBPATH = -L$(ARCH_DISTDIR)/lib -L$(GISBASE)/lib</code>
* some main makefile stuff is needed in the fragments to enable installation in alternate (ie external to installed GRASS) locations. It was suggested to move common install features to an new makefile fragment.
* dependencies need to be taken care of in bin and etc targets. vpath seems to be the key. And it's not critical, as nothing is actually built by dependencies.

= GEM =

''[...in progress... more to come...]''

Extension development

2007-10-20T16:57:07Z

⚠️Kyngchaos: /* Other Pages */

= General =

Gather ideas and resources on developing extensions. Especially for installing extensions external to the main GRASS installation.

= Other Pages =

* [[Development GEM]] - Current GEM SVN setup
* [[GRASS 7 ideas collection#Conceptual Changes|GRASS 7 Conceptual Changes]] - formalizing a user GRASS prefs and addons dir

= Environment variables =

Setting environment variables should be left up to the user or build startup.

Currently, there is a relatively new <code>GRASS_ADDON_ETC</code>. It is a list of paths which point directly to "etc/" directories where an external module can find any support data files or programs it needs (an example is the <code>adinit.dat</code> file needed by '''v.in.dwg'''). It is used by the libgis function G_find_etc(), and the general module '''g.findetc'''.

There is also <code>GRASS_ADDON_PATH</code>, which has been around for many years, and is a list of paths to "bin/" dirs where external modules can be found. This is appended to the shell <code>PATH</code>.

To simplify the possible need for an extension to need any of the standard dirs - bin, include, lib, etc, scripts, docs,... - I suggest a variable having paths point to the common root of those, say <code>GRASS_EXTN_DIR</code>. Then, as necessary, the appropriate subdir would be added. ie init.sh would add */bin to the shell <code>PATH</code> and */lib to <code>[DY]LD_LIBRARY_PATH</code>. This can easily support the $HOME/.grass7 dir idea in the future.

<code>GRASS_ADDON_PATH</code> should be kept for backwards compatibility, and it can still be useful for random user scripts. <code>GRASS_ADDON_ETC</code> should at least be deprecated, if not completely removed - it's a recent CVS addition and I doubt anyone has used it yet.

= Compilation =

In 6.3CVS, the Makefiles are now installed. With a little Makefile cleanup, and a few extra necessary items installled (demolocation and a couple tools), an installed GRASS can support compiling an extension without needing the full GRASS source, and without needing any extra module setup (as is needed currently by GEM-enabled modules). A standard GRASS module Makefile is all the would be needed.

''[...in progress... more to come...]''

Extension development

2007-10-20T16:55:35Z

⚠️Kyngchaos: New extension development ideas page

= General =

Gather ideas and resources on developing extensions. Especially for installing extensions external to the main GRASS installation.

= Other Pages =

* [[(Development) GEM}]] - Current GEM SVN setup
* [[GRASS 7 ideas collection#Conceptual Changes|GRASS 7 Conceptual Changes]] - formalizing a user GRASS prefs and addons dir

= Environment variables =

Setting environment variables should be left up to the user or build startup.

Currently, there is a relatively new <code>GRASS_ADDON_ETC</code>. It is a list of paths which point directly to "etc/" directories where an external module can find any support data files or programs it needs (an example is the <code>adinit.dat</code> file needed by '''v.in.dwg'''). It is used by the libgis function G_find_etc(), and the general module '''g.findetc'''.

There is also <code>GRASS_ADDON_PATH</code>, which has been around for many years, and is a list of paths to "bin/" dirs where external modules can be found. This is appended to the shell <code>PATH</code>.

To simplify the possible need for an extension to need any of the standard dirs - bin, include, lib, etc, scripts, docs,... - I suggest a variable having paths point to the common root of those, say <code>GRASS_EXTN_DIR</code>. Then, as necessary, the appropriate subdir would be added. ie init.sh would add */bin to the shell <code>PATH</code> and */lib to <code>[DY]LD_LIBRARY_PATH</code>. This can easily support the $HOME/.grass7 dir idea in the future.

<code>GRASS_ADDON_PATH</code> should be kept for backwards compatibility, and it can still be useful for random user scripts. <code>GRASS_ADDON_ETC</code> should at least be deprecated, if not completely removed - it's a recent CVS addition and I doubt anyone has used it yet.

= Compilation =

In 6.3CVS, the Makefiles are now installed. With a little Makefile cleanup, and a few extra necessary items installled (demolocation and a couple tools), an installed GRASS can support compiling an extension without needing the full GRASS source, and without needing any extra module setup (as is needed currently by GEM-enabled modules). A standard GRASS module Makefile is all the would be needed.

''[...in progress... more to come...]''

GRASS 6.3 Feature Plan

2007-10-20T15:59:04Z

⚠️Kyngchaos: /* Wishlist */ Makefiles to build extensions.

== GRASS 6.3.x feature plan ==
=== About feature plan ===

To make GRASS releases more often and more predictable, here is GRASS next releases feature plan. This feature plan has to be filled by developers working on GRASS 6.3.

=== TODO GRASS 6.3.0 ===
There is the release branch for 6.3.x, see details at [http://grass.itc.it/devel/cvstags.php CVS: tags and branches]. A release branch is considered as "frozen", only bugfixes can be done.

==== Beta0 ====
* complete and stabilize the native [[WinGRASS Current Status|winGRASS port]] (seems to be in a good shape now)

===== Must do =====
* <strike>replace r.proj with r.proj.seg</strike>
* <strike>d.text with d.text.new</strike>
* r.out.gdal sets NoData wrong [http://wald.intevation.org/tracker/index.php?func=detail&aid=405&group_id=21&atid=204 #405]
* Windows start script's installed on Linux (grass63.bat etc.) [http://wald.intevation.org/tracker/?group_id=21&atid=204&func=detail&aid=323 #323] and [http://wald.intevation.org/tracker/?group_id=21&atid=204&func=detail&aid=471 #471]
* g.region vect=map -a issues [http://wald.intevation.org/tracker/index.php?func=detail&aid=489&group_id=21&atid=204 #489]

===== Mostly done? =====
* use GEM for ''GRASS Addons SVN'' - status unclear

===== Wishlist =====

* modify Makefile system to support translated HTML pages. Store translated HTML files in centralized directory with locale specific subdirs, file name is module name.
* Implement [http://freegis.org/cgi-bin/viewcvs.cgi/*checkout*/grass6/doc/vector/TODO vector improvements] as suggested by Radim
* Integrate [http://mpa.itc.it/markus/i_points_auto/ i.points.auto] (merge into i.vpoints) - see also [[Image processing]] - note that A Scianna/Palermo has modernized version
* Make sqlite the default DB? <- needs more testing, for 6.5?
* drop d.m display manager (as now almost unmaintained; there is gis.m and/or a python based GUI)
: Some people still prefer it (see posts to grass-dev) and I will fix bugs in it, but not enhance/add new modules to it without good reason. So I don't see the need to drop it before the WxPython version is ready. It's not hurting us any keeping it. --Hamish
:: We should keep plain d.mon interface but why keep d.m, if gis.m has become really good? Probably we should clearly state, that d.m is UNMAINTAINED and OBSOLETE? [[User:MarisN|MarisN]] 08:24, 16 February 2007 (CET)
* raster maps: implement SQL based [[Time series in GRASS|time series support]] (Markus has working code from Soeren; done some improvements)
* Safe parallel building with make -j N [http://wald.intevation.org/tracker/?group_id=21&atid=204&func=detail&aid=359 #359]
* Clean up Makefile system to support extension compilation and installation outside the GRASS installation and without the full GRASS source. Much like what GEM does, but without needing the module source setup and not limited to installing within the GRASS installation dir. This could also simplify GEM on the compilation side. See also general [[Extension development]].

=== In progress ===
* native MS Windows port
* Database connection for v.out.vtk: --[[User:Huhabla|huhabla]] 20:47, 14 August 2006 (CEST)
** single column support for numerical data (int, float, double)
** GRASSRGB column support (done for ps.map)
** multiple column support for vector data
* rewrite most of the g3d modules to fulfil the grass function naming convention --[[User:Huhabla|huhabla]] 20:47, 14 August 2006 (CEST)
* adding further (organized) keywords to every grass command and script [http://grass.itc.it/pipermail/grass-dev/2006-August/025164.html] and [http://grass.itc.it/pipermail/grass-dev/2006-August/025190.html]:
** display commands
** database commands
** general commands
** imagery commands
** misc commands
** paint commands
** photo commands
** postscript commands
** raster commands
** raster3D commands
** vector commands
* continue with wxpython prototype
* write (Python based?) GUI wizard to create new locations (MN and terrestris.de)
* implement Python-SWIG interface
* less verbose commands
* BLAS/LAPACK updates

[[Category:Development]]
[[Category:Release Roadmap]]

Installation Guide

2006-08-23T14:21:34Z

⚠️Kyngchaos: /* Mac OS X */

== General ==

''For compilation of GRASS source code, see [[Compile and Install]].''

GRASS requires a workstation running some flavor of UNIX conforming to POSIX standards like Linux, Mac OS X, Solaris, IRIX, or BSD. It is also possible to run GRASS in MS Windows by using UNIX translation software such as Cygwin or MinGW. Ideally, you should have at least 500 Mb for data and 128 Mb RAM. The source code package needs around 30 MB uncompressed. The resulting binaries may need between 20 MB and 180 MB depending on your platform. During a full compilation you may need temporarily up to 150MB including the source code.

The [http://grass.itc.it/download/index.php Software Download Section] of the main GRASS web site contains the latest binaries and source code for all supported platforms. That site also has general directions for installing GRASS manually. However, installation is slightly different on each operating system. Here you can find user-contributed pointers for installing GRASS on specific platforms. In particular, many operating systems have package management utilities that can greatly simplify GRASS installation.

== GNU/Linux ==

=== Debian ===

A binary version of GRASS is available from the apt repository. As root type:

apt-get install grass grass-doc

This is the easiest way to install GRASS on Debian. If you choose to install a binary version manually from the main web site, be sure to follow the instructions for making symlinks found as a note to the [[http://grass.itc.it/grass61/binary/linux/snapshot/ 6.1 weekly snapshot]] release.

==== DebianGis ====

There is also the wonderfull [http://pkg-grass.alioth.debian.org/cgi-bin/wiki.pl DebianGIS] project which has a more recent GRASS version with its related packages.

To install from there follow the [http://pkg-grass.alioth.debian.org/cgi-bin/wiki.pl/DebianGisRepository instructions] there

==== Compiling GRASS from source on Debian ====
Packages needed for (nearly) complete GRASS installation from source code:
flex, bison, libreadline4-dev || libreadline5-dev, libncurses5-dev, lesstif2-dev, debhelper (>= 4.0.2), dpatch, libtiff4-dev,
tcl8.4-dev, tk8.4-dev, fftw-dev, xlibmesa-gl-dev, libfreetype6-dev, autoconf2.13, autotools-dev, libgdal1-1.3.1-dev,
proj (>= 4.4.7), libjpeg62-dev, libpng12-dev, postgresql-dev, unixodbc-dev, doxygen, fakeroot

==== Compile GRASS and package it (debian/testing) ====

grass6$ fakeroot debian/rules binary

=== Fedora ===

[http://ftp.gwdg.de/pub/misc/freegis/intevation/freegis/fedora/ Intevation] provides RPM-packages for stable releases prepared to install on Fedora systems.

=== Mandriva ===

[http://www.gdf-hannover.de GDF Hannover] provides RPM-packages for stable releases prepared to install on Mandriva systems.

You can download them here: [http://www.gdf-hannover.de/software]

=== SuSE ===

[http://www.gdf-hannover.de GDF Hannover] provides RPM-packages for stable releases prepared to install on SUSE-systems.

You can download them here: [http://www.gdf-hannover.de/software]

=== Ubuntu ===

GRASS Binaries are available from apt/synaptic. From a terminal type:

sudo apt-get install grass grass-doc

or alternatively, search for and install these packages from Synaptic. This is the easy way to get GRASS on your system. Even if you choose to install binaries from another source, you may want to install this version just so that all (most) dependencies are installed as painlessly as possible.

To get the latest version of GRASS on Ubuntu, compile the code from source. See the [[Compile and Install]] section for a shell script that makes this easy.

== Mac OS X ==

Precompiled Mac OSX packages can be found [http://www.kyngchaos.com/software/unixport here] and [http://wwwamb.bologna.enea.it/forgrass/download.htm here].

== MS-Windows ==

* Precompiled winGRASS/Cygwin 6.1 packages are provided [http://geni.ath.cx/grass.html here] (requires Cygwin unix emulator, see there).

* Precompiled native winGRASS packages with QGIS integrated are provided [http://gisalaska.com/torrents/ here] (no Cygwin needed).

[[Category:Documentation]]
[[Category:Installation]]