GRASS and Shell - Revision history

Neteler: grass7x --> grass78

2021-03-29T13:29:47Z

grass7x --> grass78

← Older revision		Revision as of 13:29, 29 March 2021
Line 14:		Line 14:

	# path to GRASS binaries and libraries:		# path to GRASS binaries and libraries:
	export GISBASE=/usr/lib64/~~grass74~~		export GISBASE=/usr/lib64/grass78

	export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts		export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts
Line 152:		Line 152:

	# create new temporary location for the job, exit after creation of this location		# create new temporary location for the job, exit after creation of this location
	~~grass70~~ -c epsg:32632 $HOME/grassdata/mytemploc_utm32n -e		grass78 -c epsg:32632 $HOME/grassdata/mytemploc_utm32n -e

	#### 2) USING THE BATCH JOB		#### 2) USING THE BATCH JOB
Line 159:		Line 159:

	# now we can use this new location and run the job defined via GRASS_BATCH_JOB		# now we can use this new location and run the job defined via GRASS_BATCH_JOB
	~~grass70~~ $HOME/grassdata/mytemploc_utm32n/PERMANENT		grass78 $HOME/grassdata/mytemploc_utm32n/PERMANENT

	#### 3) CLEANUP		#### 3) CLEANUP
Line 171:		Line 171:
	</source>		</source>

	The ~~grass70~~ command starts GRASS in the given mapset, executes the contents of the job file and leaves GRASS. Since the normal startup/closure is used, all internal tmp files are properly removed.		The grass78 command starts GRASS in the given mapset, executes the contents of the job file and leaves GRASS. Since the normal startup/closure is used, all internal tmp files are properly removed.

	Note: The $HOME variable (or the ~ shortcut) cannot be used in the batch job itself since the variables are not available here.		Note: The $HOME variable (or the ~ shortcut) cannot be used in the batch job itself since the variables are not available here.

Neteler: colorized syntax highlighting

2021-02-02T09:03:36Z

colorized syntax highlighting

← Older revision		Revision as of 09:03, 2 February 2021
Line 10:		Line 10:
	You have to set a couple of variables to enable GRASS command to run from outside GRASS:		You have to set a couple of variables to enable GRASS command to run from outside GRASS:

			<source lang="bash">
	# Example in bash shell syntax:		# Example in bash shell syntax:

Line 36:		Line 37:
	export GRASS_PNG_COMPRESSION=1		export GRASS_PNG_COMPRESSION=1
	export GRASS_MESSAGE_FORMAT=plain		export GRASS_MESSAGE_FORMAT=plain
			</source>

	Define a GRASS session with the last used GISDBASE, LOCATION_NAME, and MAPSET		Define a GRASS session with the last used GISDBASE, LOCATION_NAME, and MAPSET


			<source lang="bash">
	# path to GRASS settings file		# path to GRASS settings file
	export GISRC=$HOME/.grassrc7		export GISRC=$HOME/.grassrc7
			</source>

	Define a GRASS session with a different GISDBASE, LOCATION_NAME, and/or MAPSET		Define a GRASS session with a different GISDBASE, LOCATION_NAME, and/or MAPSET

			<source lang="bash">
	# path to GRASS settings file		# path to GRASS settings file
	export GISRC=/tmp/grass7-${USER}-$GIS_LOCK/gisrc		export GISRC=/tmp/grass7-${USER}-$GIS_LOCK/gisrc
Line 56:		Line 62:
	# start in text mode		# start in text mode
	echo "GRASS_GUI: text" >>$GISRC		echo "GRASS_GUI: text" >>$GISRC
			</source>

	The following three settings are only recommended if you will be calling the script from another program - e.g. a PHP web page using system() or exec()		The following three settings are only recommended if you will be calling the script from another program - e.g. a PHP web page using system() or exec()

			<source lang="bash">
	export HOME=/var/www		export HOME=/var/www
	export USER=www-data		export USER=www-data
	export GROUP=www-data		export GROUP=www-data
			</source>

	Now you can test:		Now you can test:

			<source lang="bash">
	# this should print the GRASS version used:		# this should print the GRASS version used:
	g.version		g.version
Line 70:		Line 80:
	g.gisenv		g.gisenv
	# other calculations go here ...		# other calculations go here ...
			</source>

	If this works, you can launch other GRASS commands. The approach works within Shell scripts and also in the command line terminal.		If this works, you can launch other GRASS commands. The approach works within Shell scripts and also in the command line terminal.
Line 75:		Line 86:
	When done, you should cleanup internal tmp files like this:		When done, you should cleanup internal tmp files like this:

			<source lang="bash">
	# run GRASS' cleanup routine		# run GRASS' cleanup routine
	$GISBASE/etc/clean_temp		$GISBASE/etc/clean_temp
Line 80:		Line 92:
	# remove session tmp directory:		# remove session tmp directory:
	rm -rf /tmp/grass7-${USER}-$GIS_LOCK		rm -rf /tmp/grass7-${USER}-$GIS_LOCK
			</source>

	'''Changing the prompt:'''		'''Changing the prompt:'''

			<source lang="bash">
	PS1_BACKUP="$PS1"		PS1_BACKUP="$PS1"
	export PS1="GRASS 6> "		export PS1="GRASS 6> "
			</source>

	Once you are done, you can set it back (see also next hint about unsetting variables):		Once you are done, you can set it back (see also next hint about unsetting variables):

			<source lang="bash">
	export PS1="$PS1_BACKUP"		export PS1="$PS1_BACKUP"
			</source>

	'''Unsetting variables after usage:'''		'''Unsetting variables after usage:'''

			<source lang="bash">
	Using the "unset VARNAME" command you get rid of it:		Using the "unset VARNAME" command you get rid of it:
	unset GISBASE		unset GISBASE
	unset GISRC		unset GISRC
	...		...
			</source>

	=== Example ===		=== Example ===

⚠️Pmolzer: /* See also */ add link to windows console page

2018-12-20T00:39:40Z

See also: add link to windows console page

← Older revision		Revision as of 00:39, 20 December 2018
Line 246:		Line 246:
	* [[GRASS and Python]]		* [[GRASS and Python]]
	* [[Working with GRASS without starting it explicitly]]		* [[Working with GRASS without starting it explicitly]]
			* [[GRASS and windows console]]

	[[Category:FAQ]]		[[Category:FAQ]]
	[[Category:Scripting]]		[[Category:Scripting]]
	[[Category:Linking to other languages]]		[[Category:Linking to other languages]]

⚠️Mmetz: /* Automated batch jobs: Setting the GRASS environmental variables */

2018-07-29T15:00:19Z

Automated batch jobs: Setting the GRASS environmental variables

← Older revision		Revision as of 15:00, 29 July 2018
Line 49:		Line 49:
	rm -fr /tmp/grass7-${USER}-$GIS_LOCK		rm -fr /tmp/grass7-${USER}-$GIS_LOCK
	mkdir /tmp/grass7-${USER}-$GIS_LOCK		mkdir /tmp/grass7-${USER}-$GIS_LOCK
			export TMPDIR="/tmp/grass7-${USER}-$GIS_LOCK"
	# set GISDBASE, LOCATION_NAME, and/or MAPSET		# set GISDBASE, LOCATION_NAME, and/or MAPSET
	echo "GISDBASE: /path/to/some/grassdata" >>$GISRC		echo "GISDBASE: /path/to/some/grassdata" >>$GISRC

Neteler at 20:39, 27 March 2018

2018-03-27T20:39:25Z

← Older revision		Revision as of 20:39, 27 March 2018
Line 5:		Line 5:
	== Automated batch jobs: Setting the GRASS environmental variables ==		== Automated batch jobs: Setting the GRASS environmental variables ==

	''Main article: [[Working with GRASS without starting it explicitly]]''		'''''Main article: [[Working with GRASS without starting it explicitly]]'''''

	This section applies to jobs which shall set the entire GRASS environment.		This section applies to jobs which shall set the entire GRASS environment.

⚠️Mmetz: Automated batch jobs: Setting the GRASS environmental variables: update for GRASS7

2018-02-07T17:01:14Z

Automated batch jobs: Setting the GRASS environmental variables: update for GRASS7

← Older revision		Revision as of 17:01, 7 February 2018
Line 25:		Line 25:
	fi		fi
	export PYTHONPATH		export PYTHONPATH

	# use process ID (PID) as lock file number:		# use process ID (PID) as lock file number:
	export GIS_LOCK=$$		export GIS_LOCK=$$
Line 37:		Line 37:
	export GRASS_MESSAGE_FORMAT=plain		export GRASS_MESSAGE_FORMAT=plain

	Define a GRASS session with the last used ~~settings~~		Define a GRASS session with the last used GISDBASE, LOCATION_NAME, and MAPSET

	# path to GRASS settings file		# path to GRASS settings file
	export GISRC=$HOME/.grassrc7		export GISRC=$HOME/.grassrc7

			Define a GRASS session with a different GISDBASE, LOCATION_NAME, and/or MAPSET

			# path to GRASS settings file
			export GISRC=/tmp/grass7-${USER}-$GIS_LOCK/gisrc
			# remove any leftover files/folder
			rm -fr /tmp/grass7-${USER}-$GIS_LOCK
			mkdir /tmp/grass7-${USER}-$GIS_LOCK
			# set GISDBASE, LOCATION_NAME, and/or MAPSET
			echo "GISDBASE: /path/to/some/grassdata" >>$GISRC
			echo "LOCATION_NAME: some_location" >>$GISRC
			echo "MAPSET: some_mapset" >>$GISRC
			# start in text mode
			echo "GRASS_GUI: text" >>$GISRC

			The following three settings are only recommended if you will be calling the script from another program - e.g. a PHP web page using system() or exec()

	~~# The following three settings are only recommended if you will be calling~~
	~~# the script from another program - e.g. a PHP web page using system() or exec()~~
	export HOME=/var/www		export HOME=/var/www
	export USER=www-data		export USER=www-data
Line 53:		Line 66:
	# this should print the GRASS version used:		# this should print the GRASS version used:
	g.version		g.version
			# check GISDBASE, LOCATION_NAME, and MAPSET
			g.gisenv
	# other calculations go here ...		# other calculations go here ...

	~~You~~ should cleanup internal tmp files like this:		If this works, you can launch other GRASS commands. The approach works within Shell scripts and also in the command line terminal.

			When done, you should cleanup internal tmp files like this:

	# run GRASS' cleanup routine		# run GRASS' cleanup routine
Line 61:		Line 78:

	# remove session tmp directory:		# remove session tmp directory:
	rm -rf /tmp/~~grass6~~-$USER-$GIS_LOCK		rm -rf /tmp/grass7-${USER}-$GIS_LOCK

	~~If this works, you can launch other GRASS commands. The approach works within Shell scripts and also in the command line terminal.~~

	'''Changing the prompt:'''		'''Changing the prompt:'''

⚠️Mmetz: Automated batch jobs: Setting the GRASS environmental variables: formatting

2018-02-05T13:45:10Z

Automated batch jobs: Setting the GRASS environmental variables: formatting

← Older revision		Revision as of 13:45, 5 February 2018
Line 17:		Line 17:
	export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts		export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts
	export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$GISBASE/lib		export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$GISBASE/lib

	# set PYTHONPATH to include the GRASS Python lib		# set PYTHONPATH to include the GRASS Python lib
	if [ ! "$PYTHONPATH" ] ; then		if [ ! "$PYTHONPATH" ] ; then

⚠️Mmetz: Automated batch jobs: Setting the GRASS environmental variables: +PYTHONPATH

2018-02-05T13:43:51Z

Automated batch jobs: Setting the GRASS environmental variables: +PYTHONPATH

← Older revision		Revision as of 13:43, 5 February 2018
Line 17:		Line 17:
	export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts		export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts
	export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$GISBASE/lib		export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$GISBASE/lib

			# set PYTHONPATH to include the GRASS Python lib
			if [ ! "$PYTHONPATH" ] ; then
			PYTHONPATH="$GISBASE/etc/python"
			else
			PYTHONPATH="$GISBASE/etc/python:$PYTHONPATH"
			fi
			export PYTHONPATH

	# use process ID (PID) as lock file number:		# use process ID (PID) as lock file number:
	export GIS_LOCK=$$		export GIS_LOCK=$$

⚠️Mmetz: Update Automated batch jobs: Setting the GRASS environmental variables

2018-02-05T13:41:37Z

Update Automated batch jobs: Setting the GRASS environmental variables

← Older revision		Revision as of 13:41, 5 February 2018
Line 8:		Line 8:

	This section applies to jobs which shall set the entire GRASS environment.		This section applies to jobs which shall set the entire GRASS environment.
	You have to set a couple of variables to enable GRASS command to run ~~(see ''''GRASS Batch jobs'''' below for a solution when you want to run the GRASS job~~ from outside GRASS):		You have to set a couple of variables to enable GRASS command to run from outside GRASS:

	# Example in bash shell syntax:		# Example in bash shell syntax:

	# path to GRASS binaries and libraries:		# path to GRASS binaries and libraries:
	export GISBASE=/usr/~~local~~/~~grass64~~		export GISBASE=/usr/lib64/grass74

	export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts		export PATH=$PATH:$GISBASE/bin:$GISBASE/scripts
Line 29:		Line 29:
	export GRASS_MESSAGE_FORMAT=plain		export GRASS_MESSAGE_FORMAT=plain

	~~The following variable defines where~~ the ~~GRASS~~ settings ~~file is stored. This can be anywhere on the system. You could also generate the '.grassrc6' on the fly in your script, even with different name. Just indicate it correctly:~~		Define a GRASS session with the last used settings

	# path to GRASS settings file		# path to GRASS settings file
	export GISRC=$HOME/.~~grassrc6~~		export GISRC=$HOME/.grassrc7

Neteler: now it works

2015-09-28T15:13:28Z

now it works

← Older revision		Revision as of 15:13, 28 September 2015
Line 91:		Line 91:
	# First we generate a script which contains the command(s) to be executed:		# First we generate a script which contains the command(s) to be executed:
	# for convenience, we save the file in our HOME directory		# for convenience, we save the file in our HOME directory
	echo "export GRASS_MESSAGE_FORMAT=plain ; v.random mymap3000 n=3000" > $HOME/my_grassjob.sh		## You may use also a text editor for this, here we use the "echo" shell command

			echo "export GRASS_MESSAGE_FORMAT=plain
			# set computational region, here: UTM32N coordinates
			g.region n=4900000 s=4800000 w=700000 e=800000 res=100
			v.random mymap3000 n=3000
			v.out.ogr input=mymap3000 output=mymap3000.shp" > $HOME/my_grassjob.sh

	# verify the content of the file		# verify the content of the file
Line 98:		Line 104:
	# make it user executable (this is important, use 'chmod' or via file manager)		# make it user executable (this is important, use 'chmod' or via file manager)
	chmod u+x $HOME/my_grassjob.sh		chmod u+x $HOME/my_grassjob.sh

	~~#### 2) USING THE BATCH JOB~~
	~~# define job file as environmental variable~~
	~~export GRASS_BATCH_JOB="$HOME/my_grassjob.sh"~~

	# create a directory (may be elsewhere) to hold the location used for processing		# create a directory (may be elsewhere) to hold the location used for processing
Line 108:		Line 110:
	# create new temporary location for the job, exit after creation of this location		# create new temporary location for the job, exit after creation of this location
	grass70 -c epsg:32632 $HOME/grassdata/mytemploc_utm32n -e		grass70 -c epsg:32632 $HOME/grassdata/mytemploc_utm32n -e

			#### 2) USING THE BATCH JOB
			# define job file as environmental variable
			export GRASS_BATCH_JOB="$HOME/my_grassjob.sh"

	# now we can use this new location and run the job defined via GRASS_BATCH_JOB		# now we can use this new location and run the job defined via GRASS_BATCH_JOB
	grass70 $HOME/grassdata/~~nc_spm_08_grass7~~/~~user1~~		grass70 $HOME/grassdata/mytemploc_utm32n/PERMANENT

			#### 3) CLEANUP
	# switch back to interactive mode, for the next GRASS GIS session		# switch back to interactive mode, for the next GRASS GIS session
	unset GRASS_BATCH_JOB		unset GRASS_BATCH_JOB

			# delete temporary location (consider to export results first in your batch job)
			rm -rf $HOME/grassdata/mytemploc_utm32n

			# Now you can use the resulting SHAPE file "mymap3000.shp" elsewhere.
	</source>		</source>

	The ~~grass64 (or~~ grass70) command starts GRASS in the given mapset, executes the contents of the job file and leaves GRASS. Since the normal startup/closure is used, all tmp files are properly removed.		The grass70 command starts GRASS in the given mapset, executes the contents of the job file and leaves GRASS. Since the normal startup/closure is used, all internal tmp files are properly removed.

	Note: The $HOME variable (or the ~ shortcut) cannot be used in the batch job since the variables are not available here.		Note: The $HOME variable (or the ~ shortcut) cannot be used in the batch job itself since the variables are not available here.

	==== Example ====		==== Example ====