Difference between revisions of "GRASS and Python"

From GRASS-Wiki
Jump to: navigation, search
m (wxPython GUI development for GRASS)
(wxPython GUI development for GRASS)
Line 73: Line 73:
==Python extensions for GRASS GIS==
==Python extensions for GRASS GIS==
=== wxPython GUI development for GRASS ===
=== wxPython GUI development for GRASS ===
See section
See section [[GRASS_and_Python#wxPython_GUI_development_for_GRASS]]
===Python-SWIG-GRASS interface===
===Python-SWIG-GRASS interface===

Revision as of 23:56, 1 February 2007

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 between shell and C programms. For C part - it can handle GRASS C functions via swig. For shell part, it can be processed with g.parser, so automatic input check and help generation (apart from translation) can be processed.

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


import sys
import os

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

def main(): 

    #add your code here
    print "" 

    if ( os.getenv("GIS_FLAG_f") != "0" ):
        print "Flag -f set"
        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_vect:    %s" % os.getenv("GIS_OPT_vect")

    #end of your code

if __name__ == "__main__":
    args = ""
    for arg in sys.argv:
        args += arg+" "
        if ( sys.argv[1] != "@ARGS_PARSED@" ):
            os.system("g.parser %s " % (args))
    except IndexError:
        os.system("g.parser %s" % (args)) 

    if sys.argv[1] == "@ARGS_PARSED@":

Python extensions for GRASS GIS

wxPython GUI development for GRASS

See section GRASS_and_Python#wxPython_GUI_development_for_GRASS

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, etc...
  • Attempts to eliminate the tedium of writing extension modules.

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

import python_grass6 as g6lib

input = 'roads'
mapset = 'PERMANENT'

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

# 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


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

import python_grass6 as g6lib

input = 'soils'
mapset = 'PERMANENT'

# initialize

# 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

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 (
  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
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}")




From FOSS4G2006: