Python/pygrass - Revision history

⚠️Ychemin: updated URL to GRASS 83 manual

2023-12-01T21:30:17Z

updated URL to GRASS 83 manual

← Older revision		Revision as of 21:30, 1 December 2023
Line 1:		Line 1:
	''PyGRASS'' is a library that extends the GRASS GIS 7 capabilities to allow users to access the low-level GRASS API.		''PyGRASS'' is a library that extends the GRASS GIS capabilities to allow users to access the low-level GRASS API.

	== Documentation ==		== Documentation ==

	Detailed PyGRASS documentation: http://grass.osgeo.org/~~grass72~~/manuals/libpython/		Detailed PyGRASS documentation: http://grass.osgeo.org/grass83/manuals/libpython/

	== How to test library ==		== How to test library ==

Neteler: fix typo

2018-01-15T10:03:12Z

fix typo

← Older revision		Revision as of 10:03, 15 January 2018
Line 156:		Line 156:
	#USER HAS TO SET THOSE		#USER HAS TO SET THOSE
	#QUIET REPORTS		#QUIET REPORTS
	~~QIET~~=True		QUIET=True
	#OVERWRITE EXISTING FILES		#OVERWRITE EXISTING FILES
	OVR=False		OVR=False
Line 287:		Line 287:
	print "Prefix IN:\t",pref		print "Prefix IN:\t",pref
	print "Prefix OUT:\t", outpref		print "Prefix OUT:\t", outpref
	i.landsat_toar(input_prefix=pref,output_prefix=outpref,metfile=metadata[0],sensor=LSENSOR,quiet=~~QIET~~,overwrite=OVR)		i.landsat_toar(input_prefix=pref,output_prefix=outpref,metfile=metadata[0],sensor=LSENSOR,quiet=QUIET,overwrite=OVR)
	#Atmospheric Correction		#Atmospheric Correction
	print "Atmospheric Correction"		print "Atmospheric Correction"
Line 338:		Line 338:
	print "\t> ",b		print "\t> ",b
	print "\t> ",b_out		print "\t> ",b_out
	i.atcorr(input=b, elevation="dem", visibility="vis", parameters=prm, output=b_out, flags="ra", range=[0,1],quiet=~~QIET~~,overwrite=OVR)		i.atcorr(input=b, elevation="dem", visibility="vis", parameters=prm, output=b_out, flags="ra", range=[0,1],quiet=QUIET,overwrite=OVR)
	r.timestamp(map=b_out,date=timestamp,finish_=False)		r.timestamp(map=b_out,date=timestamp,finish_=False)
	satbandno = satbandno + 1		satbandno = satbandno + 1
Line 366:		Line 366:
	b_ndvi=pref[:-2]+".surf.ndvi"		b_ndvi=pref[:-2]+".surf.ndvi"
	print "NDVI:\t",b_ndvi		print "NDVI:\t",b_ndvi
	i.vi(red=b3,nir=b4,output=b_ndvi,viname="ndvi",quiet=~~QIET~~,overwrite=OVR,finish_=False)		i.vi(red=b3,nir=b4,output=b_ndvi,viname="ndvi",quiet=QUIET,overwrite=OVR,finish_=False)

	b_in=[b1,b2,b3,b4,b5,b7]		b_in=[b1,b2,b3,b4,b5,b7]
	b_albedo=pref[:-2]+".surf.albedo"		b_albedo=pref[:-2]+".surf.albedo"
	print "Albedo:\t",b_albedo		print "Albedo:\t",b_albedo
	i.albedo(input=b_in,output=b_albedo,flags="lc",quiet=~~QIET~~,overwrite=OVR,finish_=False)		i.albedo(input=b_in,output=b_albedo,flags="lc",quiet=QUIET,overwrite=OVR,finish_=False)

	b_emissivity=pref[:-2]+".surf.emissivity"		b_emissivity=pref[:-2]+".surf.emissivity"
	print "Emissivity:\t",b_emissivity		print "Emissivity:\t",b_emissivity
	i.emissivity(input=b_ndvi, output=b_emissivity,quiet=~~QIET~~,overwrite=OVR,finish_=False)		i.emissivity(input=b_ndvi, output=b_emissivity,quiet=QUIET,overwrite=OVR,finish_=False)
	</source>		</source>

Neteler: /* Documentation */

2017-12-13T22:24:40Z

Documentation

← Older revision		Revision as of 22:24, 13 December 2017
Line 3:		Line 3:
	== Documentation ==		== Documentation ==

	Detailed PyGRASS documentation: http://grass.osgeo.org/~~grass71~~/manuals/libpython/		Detailed PyGRASS documentation: http://grass.osgeo.org/grass72/manuals/libpython/

	== How to test library ==		== How to test library ==

⚠️Pietro: /* Interface to copying maps (g.copy) */

2016-03-29T09:47:08Z

Interface to copying maps (g.copy)

← Older revision		Revision as of 09:47, 29 March 2016
Line 95:		Line 95:
	vectinmap = 'zipcodes_wake'		vectinmap = 'zipcodes_wake'
	vectoutmap = 'zip_elev_zonal'		vectoutmap = 'zip_elev_zonal'
	g.copy(~~vect~~=(vectinmap,vectoutmap) )		g.copy(vector=(vectinmap,vectoutmap))
	</source>		</source>

⚠️Pietro: /* Interface to copying maps (g.copy) */

2016-03-29T09:43:29Z

Interface to copying maps (g.copy)

← Older revision		Revision as of 09:43, 29 March 2016
Line 95:		Line 95:
	vectinmap = 'zipcodes_wake'		vectinmap = 'zipcodes_wake'
	vectoutmap = 'zip_elev_zonal'		vectoutmap = 'zip_elev_zonal'
	g.copy(vect=~~"%s,%s" %~~ (vectinmap,vectoutmap) )		g.copy(vect=(vectinmap,vectoutmap) )
	</source>		</source>

⚠️Pietro: /* Interface to listing maps (g.list/g.mlist) */

2016-03-29T09:42:55Z

Interface to listing maps (g.list/g.mlist)

← Older revision		Revision as of 09:42, 29 March 2016
Line 64:		Line 64:
	from grass.pygrass.modules.shortcuts import general as g		from grass.pygrass.modules.shortcuts import general as g
	import subprocess as sub		import subprocess as sub
	~~gl = g.mlist # GRASS 6~~
	gl = g.list # GRASS 7		gl = g.list # GRASS 7
	gl(type='~~rast~~', pattern='elev-*', stdout=sub.PIPE)		gl(type='raster', pattern='elev-*', stdout=sub.PIPE)
	gl.outputs.stdout.split()		gl.outputs.stdout.split()
	['elev-000-000', 'elev-000-001', 'elev-000-002', 'elev-001-000',		['elev-000-000', 'elev-000-001', 'elev-000-002', 'elev-001-000',

⚠️Pmav99: /* Interface to listing maps (g.list/g.mlist) */

2015-12-19T17:07:59Z

Interface to listing maps (g.list/g.mlist)

← Older revision		Revision as of 17:07, 19 December 2015
Line 64:		Line 64:
	from grass.pygrass.modules.shortcuts import general as g		from grass.pygrass.modules.shortcuts import general as g
	import subprocess as sub		import subprocess as sub
	gl = g.mlist		gl = g.mlist # GRASS 6
			gl = g.list # GRASS 7
	gl(type='rast', pattern='elev-*', stdout=sub.PIPE)		gl(type='rast', pattern='elev-*', stdout=sub.PIPE)
	gl.outputs.stdout.split()		gl.outputs.stdout.split()

Neteler: New URL http://grass.osgeo.org/grass71/manuals/libpython/

2014-10-30T08:46:04Z

New URL http://grass.osgeo.org/grass71/manuals/libpython/

← Older revision		Revision as of 08:46, 30 October 2014
Line 19:		Line 19:
	* Zambelli, P., Gebbert, S., Ciolli, M., 2013. ''Pygrass: An Object Oriented Python Application Programming Interface (API) for Geographic Resources Analysis Support System (GRASS) Geographic Information System (GIS)''. ISPRS International Journal of Geo-Information 2, 201–219. ([http://dx.doi.org/10.3390/ijgi2010201 DOI] \| [http://www.mdpi.com/2220-9964/2/1/201/pdf PDF])		* Zambelli, P., Gebbert, S., Ciolli, M., 2013. ''Pygrass: An Object Oriented Python Application Programming Interface (API) for Geographic Resources Analysis Support System (GRASS) Geographic Information System (GIS)''. ISPRS International Journal of Geo-Information 2, 201–219. ([http://dx.doi.org/10.3390/ijgi2010201 DOI] \| [http://www.mdpi.com/2220-9964/2/1/201/pdf PDF])

	* <strike>[http://www.ing.unitn.it/~zambelli/projects/pygrass/ (old) pyGrass documentation]</strike>		* [http://grass.osgeo.org/grass71/manuals/libpython/ pyGrass documentation] (updated weekly from SVN)
	* [http://grass.osgeo.org/~~programming7~~/~~pygrass~~/ pyGrass documentation] (updated weekly from SVN)

	== Sample PyGRASS scripts ==		== Sample PyGRASS scripts ==

Neteler: new PyGRASS URL

2014-08-23T13:24:45Z

new PyGRASS URL

← Older revision		Revision as of 13:24, 23 August 2014
Line 3:		Line 3:
	== Documentation ==		== Documentation ==

	Detailed PyGRASS documentation: http://grass.osgeo.org/grass71/manuals/~~pygrass~~/		Detailed PyGRASS documentation: http://grass.osgeo.org/grass71/manuals/libpython/

	== How to test library ==		== How to test library ==

Neteler: some cleanup

2014-05-31T23:52:48Z

some cleanup

← Older revision		Revision as of 23:52, 31 May 2014
Line 7:		Line 7:
	== How to test library ==		== How to test library ==

	''pygrass'' has doctest ~~inside~~ its code. You can run doctest ~~inside~~ the [http://grass.osgeo.org/sampledata/north_carolina/nc_basic_spm_grass7.tar.gz North Carolina basic location], using the mapset '''user1'''.		''pygrass'' has 'doctest' included in its code. You can run doctest in the [http://grass.osgeo.org/sampledata/north_carolina/nc_basic_spm_grass7.tar.gz North Carolina basic location], using the mapset '''user1'''.

	To test ~~the~~ single module (file) you have to ~~move to~~ the source code of pygrass and run the following code (this is an example of functions.py):		To test a single module (file) you have to change into the source code directory of pygrass and run the following code (this is an example of functions.py):

	<source lang="bash">		<source lang="bash">
Line 59:		Line 59:

	=== Interface to listing maps (g.list/g.mlist) ===		=== Interface to listing maps (g.list/g.mlist) ===
	~~In this case~~ we ~~are calling~~ a GRASS module that ~~write~~ to ~~the~~ stdout and not a Python function that ~~return~~ a Python object, therefore ~~you~~ can save ~~the~~ stdout and then parse it with:
			Here we call a GRASS module that writes to stdout and do not call a Python function that returns a Python object, therefore we can save stdout and then parse it with:

	<source lang="python">		<source lang="python">
Line 83:		Line 84:
	</source>		</source>

	that uses the "G_list" function through ctypes and therefore is faster.		... that uses the "G_list" function through ctypes and therefore is faster.

	If you choose the first solution is better if you use directly the		Note: If you choose the first solution it is better if you use directly the
	function in [http://grass.osgeo.org/programming7/namespacepython_1_1script_1_1core.html python.script.core.mlist_grouped() etc.].		function in [http://grass.osgeo.org/programming7/namespacepython_1_1script_1_1core.html python.script.core.mlist_grouped() etc.].

			=== Interface to copying maps (g.copy) ===
			<source lang="python">
			from grass.pygrass.modules.shortcuts import general as g

			vectinmap = 'zipcodes_wake'
			vectoutmap = 'zip_elev_zonal'
			g.copy(vect="%s,%s" % (vectinmap,vectoutmap) )
			</source>

	=== Sample script for opening, query and closing of a vector map ===		=== Sample script for opening, query and closing of a vector map ===