1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
"""Setup and initialization functions
Function can be used in Python scripts to setup a GRASS environment
without starting an actual GRASS session.
Usage::
import os
import sys
import subprocess
# define GRASS Database
# add your path to grassdata (GRASS GIS database) directory
gisdb = os.path.join(os.path.expanduser("~"), "grassdata")
# the following path is the default path on MS Windows
# gisdb = os.path.join(os.path.expanduser("~"), "Documents/grassdata")
# specify (existing) Location and Mapset
location = "nc_spm_08"
mapset = "user1"
# path to the GRASS GIS launch script
# we assume that the GRASS GIS start script is available and on PATH
# query GRASS itself for its GISBASE
# (with fixes for specific platforms)
# needs to be edited by the user
grass7bin = 'grass72'
if sys.platform.startswith('win'):
# MS Windows
grass7bin = r'C:\OSGeo4W\bin\grass72.bat'
# uncomment when using standalone WinGRASS installer
# grass7bin = r'C:\Program Files (x86)\GRASS GIS 7.2.0\grass72.bat'
# this can be avoided if GRASS executable is added to PATH
elif sys.platform == 'darwin':
# Mac OS X
# TODO: this have to be checked, maybe unix way is good enough
grass7bin = '/Applications/GRASS/GRASS-7.2.app/'
# query GRASS GIS itself for its GISBASE
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)
# set GISBASE environment variable
os.environ['GISBASE'] = gisbase
# define GRASS-Python environment
grass_pydir = os.path.join(gisbase, "etc", "python")
sys.path.append(grass_pydir)
# import (some) GRASS Python bindings
import grass.script as gscript
import grass.script.setup as gsetup
# launch session
rcfile = gsetup.init(gisbase, gisdb, location, mapset)
# example calls
gscript.message('Current GRASS GIS 7 environment:')
print gscript.gisenv()
gscript.message('Available raster maps:')
for rast in gscript.list_strings(type='raster'):
print rast
gscript.message('Available vector maps:')
for vect in gscript.list_strings(type='vector'):
print vect
# delete the rcfile
os.remove(rcfile)
(C) 2010-2012 by 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.
@author Martin Landa <landa.martin gmail.com>
@author Vaclav Petras <wenzeslaus gmail.com>
"""
# TODO: this should share code from lib/init/grass.py
# perhaps grass.py can import without much trouble once GISBASE
# is known, this would allow moving things from there, here
# then this could even do locking
import os
import sys
import tempfile as tmpfile
def write_gisrc(dbase, location, mapset):
"""Write the ``gisrc`` file and return its path."""
gisrc = tmpfile.mktemp()
with open(gisrc, 'w') as rc:
rc.write("GISDBASE: %s\n" % dbase)
rc.write("LOCATION_NAME: %s\n" % location)
rc.write("MAPSET: %s\n" % mapset)
return gisrc
def set_gui_path():
"""Insert wxPython GRASS path to sys.path."""
gui_path = os.path.join(os.environ['GISBASE'], 'gui', 'wxpython')
if gui_path and gui_path not in sys.path:
sys.path.insert(0, gui_path)
# TODO: there should be a function to do the clean up
# (unset the GISRC and delete the file)
def init(gisbase, dbase='', location='demolocation', mapset='PERMANENT'):
"""Initialize system variables to run GRASS modules
This function is for running GRASS GIS without starting it
explicitly. No GRASS modules shall be called before call of this
function but any module or user script can be called afterwards
as if it would be called in an actual GRASS session. GRASS Python
libraries are usable as well in general but the ones using
C libraries through ``ctypes`` are not (which is caused by
library path not being updated for the current process
which is a common operating system limitation).
To create a (fake) GRASS session a ``gisrc`` file is created.
Caller is responsible for deleting the ``gisrc`` file.
Basic usage::
# ... setup GISBASE and PYTHON path before import
import grass.script as gscript
gisrc = gscript.setup.init("/usr/bin/grass7",
"/home/john/grassdata",
"nc_spm_08", "user1")
# ... use GRASS modules here
# remove the session's gisrc file to end the session
os.remove(gisrc)
:param gisbase: path to GRASS installation
:param dbase: path to GRASS database (default: '')
:param location: location name (default: 'demolocation')
:param mapset: mapset within given location (default: 'PERMANENT')
:returns: path to ``gisrc`` file (to be deleted later)
"""
# TODO: why we don't set GISBASE?
mswin = sys.platform.startswith('win')
# define PATH
os.environ['PATH'] += os.pathsep + os.path.join(gisbase, 'bin')
os.environ['PATH'] += os.pathsep + os.path.join(gisbase, 'scripts')
if mswin: # added for winGRASS
os.environ['PATH'] += os.pathsep + os.path.join(gisbase, 'extrabin')
# add addons to the PATH
# copied and simplified from lib/init/grass.py
if mswin:
config_dirname = "GRASS7"
config_dir = os.path.join(os.getenv('APPDATA'), config_dirname)
else:
config_dirname = ".grass7"
config_dir = os.path.join(os.getenv('HOME'), config_dirname)
addon_base = os.path.join(config_dir, 'addons')
os.environ['GRASS_ADDON_BASE'] = addon_base
if not mswin:
os.environ['PATH'] += os.pathsep + os.path.join(addon_base, 'scripts')
# define LD_LIBRARY_PATH
if '@LD_LIBRARY_PATH_VAR@' not in os.environ:
os.environ['@LD_LIBRARY_PATH_VAR@'] = ''
os.environ['@LD_LIBRARY_PATH_VAR@'] += os.pathsep + os.path.join(gisbase, 'lib')
os.environ['GIS_LOCK'] = str(os.getpid())
# Set GRASS_PYTHON and PYTHONPATH to find GRASS Python modules
if not os.getenv('GRASS_PYTHON'):
if sys.platform == 'win32':
os.environ['GRASS_PYTHON'] = "python.exe"
else:
os.environ['GRASS_PYTHON'] = "python"
path = os.getenv('PYTHONPATH')
etcpy = os.path.join(gisbase, 'etc', 'python')
if path:
path = etcpy + os.pathsep + path
else:
path = etcpy
os.environ['PYTHONPATH'] = path
# TODO: isn't this contra-productive? may fail soon since we cannot
# write to the installation (applies also to defaults for Location
# and mapset) I don't see what would be the use case here.
if not dbase:
dbase = gisbase
os.environ['GISRC'] = write_gisrc(dbase, location, mapset)
return os.environ['GISRC']
|
