Flags:¶

-h | -help | --help

Prints a brief usage message and exits

-v | --verbose

Prints the version of GRASS and exits

-c

Creates new GRASS unprojected location in specified GISDBASE

-c geofile

Creates new GRASS projected location in specified GISDBASE based on georeferenced file

-c EPSG:code

Creates new GRASS projected location in specified GISDBASE with given EPSG code

-c EPSG:code:datum_trans

Creates new GRASS projected location in specified GISDBASE with given EPSG code and datum transform parameters

-e

Exit after creation of location or mapset. Only with -c flag

-f

Forces removal of .gislock if exists (use with care!). Only with -text flag

-text

Indicates that Text-based User Interface should be used (skip welcome screen)

-gtext

Indicates that Text-based User Interface should be used (show welcome screen)

-gui

Indicates that Graphical User Interface (wxGUI) should be used

--config

Prints GRASS configuration parameters (options: arch, build, compiler, path, revision)

--exec EXECUTABLE

Execute GRASS module or script. The provided executable will be executed in a GRASS GIS non-interactive session.

Parameters:¶

GISDBASE

Initial database directory which should be a fully qualified path (e.g., /usr/local/share/grassdata)

LOCATION_NAME

Initial location directory which is a subdirectory of GISDBASE

MAPSET

Initial mapset directory which is a subdirectory of LOCATION_NAME Note: These parameters must be specified in one of the following ways:

    MAPSET


    LOCATION_NAME/MAPSET


    GISDBASE/LOCATION_NAME/MAPSET
    

User Interface Environment Variable¶

The grass72 program will check for the existence of an environment variable called GRASS_GUI which indicates the type of user interface for GRASS to use. If this variable is not set when grass72 is run, then it will be created and then saved in the $HOME/.grass7/rc file for the next time GRASS is run. It can be set to text, gtext or gui.

There is an order of precedence in the way grass72 determines the user interface to use. The following is the hierarchy from highest precedence to lowest.

1

Command line argument

2

Environment variable GRASS_GUI

3

Value set in $HOME/.grass7/rc (GUI)

4

Default value - gui

Python Environment Variables¶

If you choose to use wxGUI interface, then the GRASS_PYTHON environment variable can be used to override your system default python command.

Suppose for example your system has Python 2.6 installed and you install a personal version of the Python 2.7 binaries under $HOME/bin. You can use the above variables to have GRASS use the Python 2.7 binaries instead.

   GRASS_PYTHON=python2.7

Addon Path to Extra User Scripts¶

This environment variable allows the user to extend the GRASS program search paths to include locally developed/installed GRASS modules or user scripts.

   GRASS_ADDON_PATH=/usr/mytools


   GRASS_ADDON_PATH=/usr/mytools:/usr/local/othertools

In this example above path(s) would be added to the standard GRASS path environment.

Addon Base for Extra Local GRASS Addon Modules¶

This environment variable allows the user to extend the GRASS program search paths to include locally installed (see g.extension for details) GRASS Addon modules which are not distributed with the standard GRASS release.

   GRASS_ADDON_BASE=/usr/grass-addons

In this example above path would be added to the standard GRASS path environment.

If not defined by user, this variable is set by GRASS startup program to $HOME/.grass7/addons on GNU/Linux and $APPDATA\GRASS7\addons on MS Windows.

HTML Browser Variable¶

The GRASS_HTML_BROWSER environment variable allows the user to set the HTML web browser to use for displaying help pages.

Location Environment Variables¶

The Synopsis section above describes options that can be used to set the location and mapset that GRASS will use. These values can also be set with environment variables. However, specifying the location and mapset variables on the command line will override these environment variables. The available variables are as follows:

LOCATION

A fully qualified path to a mapset (eg /usr/local/share/grassdata/spearfish70/PERMANENT). This environment variable overrides the GISDBASE, LOCATION_NAME, and MAPSET variables.

GISDBASE

Initial database directory which should be a fully qualified path (eg /usr/local/share/grassdata)

LOCATION_NAME

Initial location directory which is a subdirectory of GISDBASE

MAPSET

Initial mapset directory which is a subdirectory of LOCATION_NAME

Running non-interactive batch jobs¶

If the GRASS_BATCH_JOB environment variable is set to the full path and filename of a shell script then GRASS will be launched in a non-interactive way and the script will be run. The script itself can be interactive if that is what the user requires. When it is finished GRASS will automatically exit using the exit-success code given by the script. The script file must have its executable bit set.

Batch jobs with the exec interface¶

Creating a new Location based on a geodata file’s projection (-c) and exit (-e) immediately:

grass72 -c elevation.tiff -e /path/to/grassdata/test1/

Linking external raster data to PERMANENT Mapset:

grass72 /path/to/grassdata/test1/PERMANENT/ --exec r.external input=basins.tiff output=basins
grass72 /path/to/grassdata/test1/PERMANENT/ --exec r.external input=elevation.tiff output=elevation

Get statistics for one raster map:

grass72 /path/to/grassdata/test1/PERMANENT/ --exec r.univar map=elevation

Compare the rasters visually:

grass72 /path/to/grassdata/test1/PERMANENT/ --exec g.gui.mapswipe first=elevation second=basins

Execution of shell and Python scripts instead of single commands¶

A sequence of commands can be bundled in a script and executed using the exec interface.

Shell script example: the command to execute a shell script might be:

grass72 /path/to/grassdata/test1/PERMANENT/ --exec sh test.sh

#!/bin/bash
g.region -p
g.list type=raster
r.info elevation

Python script example: the command to execute a Python script might be:

grass72 /path/to/grassdata/test1/PERMANENT/ --exec python test.py

#!/usr/bin/env python
# import GRASS Python bindings (see also pygrass)
import grass.script as gscript
import grass.script.setup as gsetup
gscript.message(’Current GRASS GIS 7 environment:’)
print(gscript.gisenv())
gscript.message(’Available raster maps:’)
for raster in gscript.list_strings(type=’raster’):


    print(raster)
gscript.message(’Available vector maps:’)
for vector in gscript.list_strings(type=’vector’):


    print(vector)

Troubleshooting¶

Importantly, to avoid an "[Errno 8] Exec format error" there must be a shebang line at the top of the script (like #!/bin/sh, #!/bin/bash, or #!/usr/bin/env python) indicating which interpreter to be used for the script. The script file must have its executable bit set.

Other examples¶

There are a variety of ways in which the location environment variables (see above) can be used to specify the mapset to use. The following are some possible examples.

Example 1¶

The environment variables are defined as follows:

LOCATION = /usr/local/share/grassdata/spearfish70/PERMANENT
GISDBASE = /usr/local/share/grassdata
LOCATION_NAME = spearfish70
MAPSET = PERMANENT

Start GRASS with the following command:

grass72 -

GRASS will start with the mapset defined by LOCATION since the LOCATION variable overrides the other variables.

Example 2¶

The environment variables are defined as follows:

GISDBASE = /usr/local/share/grassdata
LOCATION_NAME = spearfish70
MAPSET = PERMANENT

Start GRASS with the following command:

grass72 -

GRASS will start with the mapset defined by GISDBASE/LOCATION_NAME/MAPSET.

grass72 /usr/home/grass/data/thailand/forests

GRASS will start with the mapset /home/grass/data/thailand/forests which overrides the environment variables.

grass72 swamps

GRASS will start with the mapset defined by GISDBASE/LOCATION_NAME/swamps since the command line argument for the mapset overrides the environment variable MAPSET.

grass72 thailand/forests

GRASS will start with the mapset defined by GISDBASE/thailand/forests since the command line arguments for the location and mapset overrides the environment variables LOCATION_NAME and MAPSET.