[GIS] Using Spyder IDE to develop python for Grass GIS, get ‘ImportError: No module named grass.script’

grassgrass.scriptimporterrorpythonspyder

I am trying to use Spyder IDE to develop a python script using python library from grass-6.4.3. I run the script below, and get

ImportError: No module named grass.script

I am using python 2.7, installed in Grass, Spyder, + native install (C:\python27) and my OS is 64-bit Windows 7.

This seems to be a common problem, but I have tried all the recommended fixes outlined below. I have even tried installing on a laptop running 32-bit windows 7 and get the same error.

I read the Grass wiki: page:https://grasswiki.osgeo.org/wiki/GRASS_and_Python#External_Python_editors_.28IDE.29

Then I tried to follow this Q&A to the letter: Problem with python script to control GRASS GIS from outside – How to import grass.script under Win 8.1?

My python script:

import sys
import os

gisbase = os.environ['GISBASE'] = 'C:\OSGeo4W64\apps\grass\grass-6.4.3'  
gisdbase = os.path.normpath('C:/Users/Ryan/grassdata')
location = 'newLocation'
mapset = 'Ryan'
GISRC = os.path.normpath('C:/Users/Ryan/AppData/Roaming/GRASS6/grassrc6')
LD_LIBRARY_PATH = 'C:\OSGeo4W64\apps\grass\grass-6.4.3\lib'
PATH = 'C:\Python27';'C:\Users\Ryan\grassdata';'C:\Users\Ryan\AppData\Roaming\GRASS6\grassrc6';'C:\OSGeo4W64\bin';'C:\OSGeo4W64\apps\grass\grass-6.4.3';'C:\OSGeo4W64\apps\grass\grass-6.4.3\lib';'C:\OSGeo4W64\apps\grass\grass-6.4.3\etc\python';'C:\OSGeo4W64\apps\grass\grass-6.4.3\etc';'C:\OSGeo4W64\apps\grass\grass-6.4.3\bin';'C:\OSGeo4W64\apps\Python27';'C:\OSGeo4W64\apps\Python27\Lib\site-packages';'C:\OSGeo4W64\apps\msys';'C:\OSGeo4W64\apps\grass\grass-6.4.3\scripts'
PYTHONLIB = 'C:\Python27'
PYTHONPATH = 'C:\OSGeo4W64\apps\grass\grass-6.4.3\etc\python'
GRASS_SH = 'C:\OSGeo4W64\apps\msys\bin\sh.exe'

sys.path.append(os.path.join(os.environ['GISBASE'], 'etc', 'python'))
sys.path.append('C:\OSGeo4W\bin')
sys.path.append('C:\OSGeo4W64\apps\grass\grass-6.4.3\etc') 
sys.path.append('C:\OSGeo4W64\apps\grass\grass-6.4.3\etc\python') 
sys.path.append('C:\OSGeo4W64\apps\grass\grass-6.4.3\lib') 
sys.path.append('C:\OSGeo4W64\apps\grass\grass-6.4.3\bin') 

import grass.script as grass
import grass.script.setup as gsetup

gsetup.init(gisbase, gisdb, location, mapset)

I have added my environment variables manually into system settings (copied here):

GISBASE = C:\OSGeo4W64\apps\grass\grass-6.4.3
GISDBASE = C:\Users\Ryan\grassdata
GISRC = C:\Users\Ryan\AppData\Roaming\GRASS6\grassrc6
GRASS_SH = C:\OSGeo4W\apps\msys\bin\sh.exe
LD_LIBRARY_PATH = C:\OSGeo4W64\apps\grass\grass-6.4.3\lib
PATH = C:\Python27;C:\Users\Ryan\grassdata;C:\Users\Ryan\AppData\Roaming\GRASS6\grassrc6;C:\OSGeo4W64\bin;C:\OSGeo4W64\apps\grass\grass-6.4.3;C:\OSGeo4W64\apps\grass\grass-6.4.3\lib;C:\OSGeo4W64\apps\grass\grass-6.4.3\etc\python;C:\OSGeo4W64\apps\grass\grass-6.4.3\etc;C:\OSGeo4W64\apps\grass\grass-6.4.3\bin;C:\OSGeo4W64\apps\Python27;C:\OSGeo4W64\apps\Python27\Lib\site-packages;C:\OSGeo4W64\apps\msys;C:\OSGeo4W64\apps\grass\grass-6.4.3\scripts
PYTHONLIB = C:\Python27
PYTHONPATH = C:\OSGeo4W\apps\grass\grass-6.4.3\etc\python'

I have added a file called 'grass.pth' to: C:\OSGeo4W\apps\python27\lib\site-packages. The file contains:

C:\OSGeo4W\apps\grass\grass-6.4.3\etc\python C:\OSGeo4W\bin

I have started grass interactively to create a 'grassrc6' file, which is located here: C:\Users\Ryan\AppData\Roaming\GRASS6\grassrc6

I am not sure what else I can try, I am certain something must be wrong with the environment variables, but I wouldn't know what to look for.

Also, is it necessary to define the environment variables in both the python script, and manually in system settings?

Best Answer

This bat file starts spyder for me and imports grass.script fine:

@echo off
rem set OSGEO4W_ROOT=c:\OSGEO4W64
rem set PATH=%OSGEO4W_ROOT%\bin;%PATH%
call c:\osgeo4w64\bin\o4w_env.bat
call %OSGEO4W_ROOT%\apps\grass\grass-6.4.3\etc\env.bat
set GDAL_DRIVER_PATH=%OSGEO4W_ROOT%\bin\gdalplugins\1.9
set PATH=%PATH%;%OSGEO4W_ROOT%\apps\qgis\bin
set PATH=%PATH%;%OSGEO4W_ROOT%\apps\grass\grass-6.4.3\lib
set PATH=%PATH%;%OSGEO4W_ROOT%\apps\Python27\Scripts\
set GISBASE=C:\OSGeo4W64\apps\grass\grass-6.4.3
set GISDBASE=d:\documents\grassdata
set GISRC=C:\Users\sando_000\AppData\Roaming\GRASS6\grassrc6
set GRASS_SH=C:\OSGeo4W\apps\msys\bin\sh.exe
set PYTHONPATH=%PYTHONPATH%;%OSGEO4W_ROOT%\apps\qgis\python;
set PYTHONPATH=%PYTHONPATH%;%OSGEO4W_ROOT%\apps\Python27\Lib\site-packages
set PYTHONPATH=%PYTHONPATH%;%OSGEO4W_ROOT%\apps\grass\grass-6.4.3\etc\python
set QGISPATH=%OSGEO4W_ROOT%\apps\qgis
start c:\OSGeo4W64\apps\Python27\Scripts\spyder.bat

I've got an OSGE4W 64bit installation w grass-6.4.3, python-2.7 and spyder installed from source package with:

python setup.py install

This script is a modified version from what used to start pyscripter with qgis: https://mapoholic.wordpress.com/2012/06/28/configure-pyscripter-qgis/

Related Solutions

[GIS] Install GRASS Addon within QGIS

The solution is given in the r.viewshed.cva.py

It is a Python script and the line 189 is:

 grass.run_command("r.viewshed",....

So you need to install r.vieshed first but most Windows computers don't have a common compiler and a building environment built. The developers compile every night the addon modules for Windows (see Installing an addon in winGRASS 7.0 for complete dummy , it is the same for GRASS GIS 6.4.3). They are in Win GRASS 6.4.3 addons

If you don't want to use g.extension, download r.viewshed.zip and r.viewshed.cva.zip, an unzip in your GRASS_ADDON_PATH (C:\Users\Warsow.grass6/1/addons/? from your output)

GRASS GIS – Connecting Python Script External to GRASS GIS 7 Program in Windows 10

The linked says you need to set environmental variables. This is done in Python using e.g.:

import os
os.environ['GISBASE'] = "/some/path"

The syntax

PYTHONPATH = 'C:\OSGeo4W\apps\grass\grass-7.0.4\etc\python'

in Python just sets a variable (global one in your case) which is just a Python variable, nothing more, nothing less. The aforementioned wiki just lists the environmental variables to be set. How you set them is up to you. You can do it ahead in the command line before starting Python, you can change it in the system (search the Internet for how to do it in some GUI for your version of MS Windows), or you can use Python (os.environ).

Here is an example how to setup the environment (simplified from GRASS Python doc):

import os
import sys
import subprocess

grass7bin = r'C:\Program Files\GRASS GIS 7.0.4\grass70.bat'
startcmd = [grass7bin, '--config', 'path']
try:
    p = subprocess.Popen(startcmd, shell=False,
                         stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    out, err = p.communicate()
except OSError as error:
    sys.exit("ERROR: Cannot find GRASS GIS start script"
             " {cmd}: {error}".format(cmd=startcmd[0], error=error))
if p.returncode != 0:
    sys.exit("ERROR: Issues running GRASS GIS start script"
             " {cmd}: {error}"
             .format(cmd=' '.join(startcmd), error=err))
gisbase = out.strip(os.linesep)

os.environ['GISBASE'] = gisbase
grass_pydir = os.path.join(gisbase, "etc", "python")
sys.path.append(grass_pydir)

import grass.script.setup as gsetup

gisdb = os.path.join(os.path.expanduser("~"), "Documents/grassdata")
location = "nc_spm_08"
mapset = "user1"

rcfile = gsetup.init(gisbase, gisdb, location, mapset)

# use grass functions here

os.remove(rcfile)

Now you put your GRASS module calls and GRASS Python API function calls to the place where # use grass functions here is.

Note that you don't do anything from the above if you just run the code from inside GRASS GIS session. However, the code once you have the environment done in the right way is the same and looks for example like this:

import grass.script as gscript

gscript.run_command('g.region', s=10, n=50, w=30, e=60, res=2)
gscript.mapcalc('test1 = sin(col() + row())')
print gscript.read_command('r.info', map='test1', flags='g')
print gscript.parse_command('r.univar', map='test1', flags='g')

Best Answer

Related Solutions

[GIS] Install GRASS Addon within QGIS

GRASS GIS – Connecting Python Script External to GRASS GIS 7 Program in Windows 10

Related Question