GRASS and Python

(for discussions on the new GRASS GUI, see here)

Python SIGs

Python Special Interest Groups are focused collaborative efforts to develop, improve, or maintain specific Python resources. Each SIG has a charter, a coordinator, a mailing list, and a directory on the Python website. SIG membership is informal, defined by subscription to the SIG's mailing list. Anyone can join a SIG, and participate in the development discussions via the SIG's mailing list. Below is the list of currently active Python SIGs, with links to their resources.

See more at http://www.python.org/community/sigs/

Writing Python scripts in GRASS

Python is a programming language which is more powerful than shell scripting but easier and more forgiving than C. The Python script can contain simple module description definitions which will be processed with g.parser, as shown in the example below. In this way with no extra coding a GUI can be built, inputs checked, and a skeleton help page can be generated automatically. In addition it adds links to the GRASS message translation system. For code which needs access to the power of C, you can access the GRASS C library functions via the SWIG interface.

Have a look at SUBMITTING_PYTHON.

Running external commands from Python

For information on running external commands from Python, see: http://docs.python.org/lib/module-subprocess.html

Avoid using the older os.* functions. Section 17.1.3 lists equivalents using the Popen() interface, which is more robust (particularly on Windows).

Example

Example of python script, which is processed by g.parser:

#!/usr/bin/python
############################################################################
#
# MODULE:       g.example
#
# AUTHOR(S):    Jane GrassUser
#
# PURPOSE:      Demonstrates GRASS parser usage in a Python script
#
# COPYRIGHT:    (c) 2007 The GRASS Development Team
#
#               This program is free software under the GNU General Public
#               License (>=v2). Read the file COPYING that comes with GRASS
#               for details.
#
############################################################################
#
# REQUIREMENTS:
#      - footool: http://www.example.org

#%Module
#%  description: g.parser test script
#%  keywords: keyword1, keyword2
#%End
#%flag
#%  key: f
#%  description: a flag
#%END
#%option
#%  key: raster
#%  type: string
#%  gisprompt: old,cell,raster
#%  description: raster input map
#%  required : yes
#%end
#%option
#%  key: vector
#%  type: string
#%  gisprompt: old,vector,vector
#%  description: vector input map
#%  required : yes
#%end
#%option
#%  key: option1
#%  type: string
#%  description: an option
#%  required : yes
#%end

import sys
import os

def main(): 

    #### add your code here ####

    print "" 

    if ( os.getenv("GIS_FLAG_F") == "1" ):
        print "Flag -f set"
    else:
        print "Flag -f not set"

    print "Value of GIS_OPT_OPTION1: %s" % os.getenv("GIS_OPT_OPTION1")
    print "Value of GIS_OPT_RASTER:  %s" % os.getenv("GIS_OPT_RASTER")
    print "Value of GIS_OPT_VECTOR:  %s" % os.getenv("GIS_OPT_VECTOR")

    #### end of your code ####
    return 

if __name__ == "__main__":
    if ( len(sys.argv) <= 1 or sys.argv[1] != "@ARGS_PARSED@" ):
        os.execvp("g.parser", [sys.argv[0]] + sys.argv)
    else:
	main();

Python extensions for GRASS GIS

wxPython GUI development for GRASS

• See the GRASS GUI wiki page

Python-SWIG-GRASS interface

There is a prototype GRASS-SWIG interface available (thanks to Sajith VK), find it in GRASS 6-CVS: swig/python/. Draft documentation is here. It now wraps both raster and vector data C functions plus the general GIS (G_*()) functions.

Background: SWIG (Simplified Wrapper and Interface Generator) is:

• A compiler that turns ANSI C/C++ declarations into scripting language interfaces.
• Completely automated (produces a fully working Python extension module).
• Language neutral. SWIG can also target Tcl, Perl, Guile, MATLAB (try PyLab+Matplotlib from python), etc...
• Attempts to eliminate the tedium of writing extension modules.

Python-SWIG examples

• More complicated examples

Sample script for raster access (use within GRASS, Spearfish session):

#!/usr/bin/python
import python_grass6 as g6lib

input = 'roads'
mapset = 'PERMANENT'

# initialize
g6lib.G_gisinit('')
infd = g6lib.G_open_cell_old(input, mapset)
cell = g6lib.G_allocate_cell_buf()

rown=0
# the API still needs error checking to be added
while 1:
    myrow = g6lib.G_get_map_row_nomask(infd, cell, rown)
    print rown,myrow[0:10]
    rown = rown+1
    if rown==476:break

g6lib.G_close_cell(infd)
g6lib.G_free(cell)

Sample script for vector access (use within GRASS, Spearfish session):

#!/usr/bin/python
import python_grass6 as g6lib

input = 'soils'
mapset = 'PERMANENT'

# initialize
g6lib.G_gisinit('')

# define map structure
map = g6lib.Map_info()

# define open level (level 2: topology)
g6lib.Vect_set_open_level (2)

# open existing map
g6lib.Vect_open_old(map, input, mapset)

# query
print 'Vect is 3D: ', g6lib.Vect_is_3d (map)
print 'Vect DB links: ', g6lib.Vect_get_num_dblinks(map)
print 'Map Scale:  1:', g6lib.Vect_get_scale(map)

# close map
g6lib.Vect_close(map)

TODO

• Implement modules support in a Python class using --interface-description and a Python-XML parser. This should be a generic class with module's name as parameter, returning back an object which describes the module (description, flags, parameters, status of not/required). See GRASS 6 wxPython interface for inspiration. Important is to auto-generate the GRASS-Python class at compile time with a Python script.

Python-GRASS add-ons

Stand-alone addons:

1. Jáchym Čepický's G-ps.map, a GUI to typeset printable maps with ps.map (http://193.84.38.2/~jachym/index.py?cat=gpsmap)
2. Jáchym Čepický's v.pydigit, a GUI to v.edit (http://les-ejk.cz/?cat=vpydigit)
3. Jáchym Čepický's PyWPS, GRASS-Web Processing Service (http://pywps.wald.intevation.org)

Using Grass gui.tcl in python

Here is some example code to use the grass automatically generated guis in python code. This could (should) all be bundled up and abstracted away so that the implementation can be replaced later.

import Tkinter
import os

# Startup (once):

tk = Tkinter.Tk()
tk.eval ("wm withdraw .")
tk.eval ("source $env(GISBASE)/etc/gui.tcl")
# Here you could do various things to change what the gui does
# See gui.tcl and README.GUI

# Make a gui (per dialog)
# This sets up a window for the command.
# This can be different to integrate with tkinter:
tk.eval ('set path ".dialog$dlg"')
tk.eval ('toplevel .dialog$dlg')
# Load the code for this command:
fd = os.popen ("d.vect --tcltk")
gui = fd.read()
# Run it
tk.eval(gui)
dlg = tk.eval('set dlg') # This is used later to get and set 

# Get the current command in the gui we just made:
currentcommand = tk.eval ("dialog_get_command " + dlg)

# Set the command in the dialog we just made:
tk.eval ("dialog_set_command " + dlg + " {d.vect map=roads}")

Links

Programming

• Quick Python tutorial for programmers of other languages

More Python tutorials for programmers

• Python programming style guide

• GRASS-SWIG interface http://download.osgeo.org/grass/grass6_progman/swig/ based on SWIG http://www.swig.org/

• PyWPS, GRASS-Web Processing Service http://pywps.wald.intevation.org

• SIP (C/C++ bindings generator) http://directory.fsf.org/all/Python-SIP.html
• Cython - C-Extensions for Python (compile where speed is needed)

• Python and GDAL/OGR:
  • Open Source Python GIS Hacks Mum'03
  • http://hobu.biz/software/OSGIS_Hacks - Python OSGIS Hacks '05
  • http://zcologia.com/news/categorylist_html?cat_id=8
  • http://www.perrygeo.net/wordpress/?p=4

• Python bindings to PROJ:
  • http://www.cdc.noaa.gov/people/jeffrey.s.whitaker/python/pyproj.html

• RPy - Python interface to the R-statistics programming language

• Other external projects
  • Scientific Python
  • Numeric and Scientific
  • Info on Python for Scientific Applications

Presentations

From FOSS4G2006:

• A Python sweeps in the GRASS - A. Frigeri 2006
• GRASS goes web: PyWPS - J. Cepicky 2006