Skip to content

Commit a277d85

Browse files
docs: Standardize naming: use "GRASS" instead of "GRASS GIS" (#5644)
1 parent 1613a87 commit a277d85

27 files changed

+119
-119
lines changed

doc/NIX.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ tool that aims to make software deployment fully reproducible.
1616
| sh -s -- install
1717
```
1818

19-
## Create GRASS GIS development environment
19+
## Create GRASS development environment
2020

2121
Nix provides a development environment containing all required dependencies.
2222

@@ -34,7 +34,7 @@ Nix provides a development environment containing all required dependencies.
3434
direnv allow
3535
```
3636

37-
## Launch GRASS GIS directly from the source code
37+
## Launch GRASS directly from the source code
3838

3939
Nix allows to run a program directly from git source code repository using
4040
following command:
@@ -62,7 +62,7 @@ nix run \
6262
nix run github:<PR-OWNER>/grass/<PR-BRANCH>#grass
6363
```
6464

65-
## Install GRASS GIS directly from the source code
65+
## Install GRASS directly from the source code
6666

6767
To install a program permanently, use following command:
6868

@@ -83,7 +83,7 @@ nix profile install \
8383
nix profile install github:OSGeo/grass/<REVISION|BRANCH|TAG>#grass
8484
```
8585

86-
## Uninstall GRASS GIS
86+
## Uninstall GRASS
8787

8888
- List installed programs
8989

doc/debugging.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
GRASS GIS Debugging:
1+
GRASS Debugging:
22

33
See also
44
https://grasswiki.osgeo.org/wiki/GRASS_Debugging

doc/development/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Find below the development and maintenance documentation.
44
The API documentation is available in the appropriate places,
55
but here is the information relevant to contributing to and
6-
maintaining GRASS GIS.
6+
maintaining GRASS.
77

88
## Style and GitHub guide
99

doc/development/branching_how-to.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ Update the version in the source code (use `minor` or `major`):
5757
./utils/update_version.py minor
5858
```
5959

60-
If you are using a clone you use for building GRASS GIS,
61-
clean up (`make distclean`) your GRASS GIS build to remove
60+
If you are using a clone you use for building GRASS,
61+
clean up (`make distclean`) your GRASS build to remove
6262
the now outdated generated version numbers.
63-
(You don't need to build GRASS GIS if you have a fresh clone.)
63+
(You don't need to build GRASS if you have a fresh clone.)
6464

6565
Search for all other mentions of the last few versions to see
6666
if they need to be updated, for example:

doc/development/github_guide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Guide to contributing on GitHub
22

3-
This guide covers contributing to the GRASS GIS source,
3+
This guide covers contributing to the GRASS source,
44
specifically to the _main_ branch.
55
It assumes that you have some very basic knowledge of Git and GitHub.
66

@@ -23,14 +23,14 @@ git clone https://github.com/your_GH_account/grass.git
2323
cd grass/
2424
```
2525

26-
1. Add the main GRASS GIS repository as "upstream" (use HTTPS URL):
26+
1. Add the main GRASS repository as "upstream" (use HTTPS URL):
2727

2828
```bash
2929
git remote add upstream https://github.com/OSGeo/grass
3030
```
3131

3232
1. Your remotes now should be "origin" which is your fork and "upstream" which
33-
is this main GRASS GIS repository. You can confirm that using:
33+
is this main GRASS repository. You can confirm that using:
3434

3535
```bash
3636
git remote -v
@@ -143,7 +143,7 @@ to help standardize the content.
143143

144144
## After creating a PR
145145

146-
GRASS GIS maintainers will now review your PR.
146+
GRASS maintainers will now review your PR.
147147
If needed, the maintainers will work with you to improve your changes.
148148

149149
Once the changes in the PR are ready to be accepted,

doc/development/style_guide.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ The `--overwrite` flag can be globally enabled by setting the environment variab
446446

447447
#### Mask
448448

449-
GRASS GIS has a global mask managed by the _r.mask_ tool and represented by a
449+
GRASS has a global mask managed by the _r.mask_ tool and represented by a
450450
raster called MASK by default. Raster tools called as a subprocess will automatically
451451
respect the globally set mask when reading the data. For outputs, respecting of
452452
the mask is optional.
@@ -876,13 +876,12 @@ Notes:
876876
[keyword index](https://grass.osgeo.org/grass-devel/manuals/keywords.html) in
877877
the manual
878878

879-
These index manual pages are autogenerated during the build process of GRASS
880-
GIS.
879+
These index manual pages are autogenerated during the build process of GRASS.
881880

882881
#### Lazy import of optional dependencies
883882

884883
A tool may use a package that is not [required](../../REQUIREMENTS.md)
885-
by GRASS GIS and may not be available on a user's system.
884+
by GRASS and may not be available on a user's system.
886885
In these cases, import only after the _gs.parser_ call. In that way the
887886
tool can be safely compiled even if the dependency is not installed.
888887

doc/examples/gui/wxpython/README

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Motivation
22
----------
33
Example Tool should help new GRASS GUI programmers who are interested in
4-
adding or improving GRASS GIS functionality or writing GRASS GIS GUI-based
4+
adding or improving GRASS functionality or writing GRASS GUI-based
55
application for their own purposes.
66

77
How to use Example Tool

doc/examples/notebooks/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ the notebook.
1515
See also the official documentation for
1616
[The Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/latest/).
1717

18-
### Introductory notebooks to GRASS GIS and Jupyter
18+
### Introductory notebooks to GRASS and Jupyter
1919

20-
* GRASS GIS in Jupyter Notebook with Python and grass.jupyter:
20+
* GRASS in Jupyter Notebook with Python and grass.jupyter:
2121
[jupyter_example.ipynb](jupyter_example.ipynb)
2222
* The grass.jupyter Package: [jupyter_tutorial.ipynb](jupyter_tutorial.ipynb)
2323

@@ -27,6 +27,6 @@ See also the official documentation for
2727
* Spatio-Temporal Analysis with grass.jupyter: [temporal.ipynb](temporal.ipynb)
2828
* Solar Energy Potential Analysis:
2929
[solar_potential.ipynb](solar_potential.ipynb)
30-
* GRASS GIS Scripting with Python:
30+
* GRASS Scripting with Python:
3131
[scripting_example.ipynb](scripting_example.ipynb)
32-
* Hydrology with GRASS GIS: [hydrology.ipynb](hydrology.ipynb)
32+
* Hydrology with GRASS: [hydrology.ipynb](hydrology.ipynb)

doc/examples/notebooks/temporal.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"cell_type": "markdown",
4444
"metadata": {},
4545
"source": [
46-
"## Start GRASS GIS"
46+
"## Start GRASS"
4747
]
4848
},
4949
{
@@ -52,7 +52,7 @@
5252
"metadata": {},
5353
"outputs": [],
5454
"source": [
55-
"# Ask GRASS GIS where its Python packages are.\n",
55+
"# Ask GRASS where its Python packages are.\n",
5656
"sys.path.append(\n",
5757
" subprocess.check_output([\"grass\", \"--config\", \"python_path\"], text=True).strip()\n",
5858
")\n",

doc/examples/python/raster_example_ctypes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
# check if GRASS is running or not
3939
if "GISBASE" not in os.environ:
40-
sys.exit("You must be in GRASS GIS to run this program")
40+
sys.exit("You must be in GRASS to run this program")
4141

4242
# parse command line arguments, prompt user for a raster map name if one wasn't given
4343
input = sys.argv[1] if len(sys.argv) == 2 else input("Name of raster map? ")

doc/examples/python/vector_example_ctypes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
)
3232

3333
if "GISBASE" not in os.environ:
34-
sys.exit("You must be in GRASS GIS to run this program.")
34+
sys.exit("You must be in GRASS to run this program.")
3535

3636
input = sys.argv[1] if len(sys.argv) == 2 else input("Name of vector map? ")
3737

doc/examples/raster/r.example/r.example.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## DESCRIPTION
22

33
*r.example* does practically do nothing, except for illustrating GRASS
4-
GIS raster programming. It copies over an existing raster map to a new
4+
raster programming. It copies over an existing raster map to a new
55
raster map. See the source code for details.
66

77
## NOTES

doc/grass_database.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
2-
description: GRASS GIS Database
2+
description: GRASS Database
33
---
44

5-
# GRASS GIS Database
5+
# GRASS Database
66

7-
A GRASS GIS Database is simply a set of directories and files with
8-
certain structure which GRASS GIS works efficiently with. Project is a
7+
A GRASS Database is simply a set of directories and files with
8+
certain structure which GRASS works efficiently with. Project is a
99
directory with data related to one geographic location or a project. All
1010
data within one project has the same coordinate reference system. A
1111
project contains mapsets and each mapset contains data related to a
1212
specific task, user or a smaller project. Within each project, a
1313
mandatory PERMANENT mapset exists which can contain commonly used data
1414
within one GRASS project such as base maps. The PERMANENT mapset also
1515
contains metadata related to the project such as the coordinate
16-
reference system. When GRASS GIS is started it connects to a database,
16+
reference system. When GRASS is started it connects to a database,
1717
project and mapset specified by the user.
1818

1919
![example: nc_spm - highway - elevation](grass_database.png)
20-
*Fig. 1: GRASS GIS Database structure as visible to the user*
20+
*Fig. 1: GRASS Database structure as visible to the user*
2121

22-
## GRASS GIS Database Directory
22+
## GRASS Database Directory
2323

24-
All data for GRASS GIS must be in GRASS GIS Database which is a
24+
All data for GRASS must be in GRASS Database which is a
2525
directory (visible on the disk) containing subdirectories which are
2626
GRASS projects. User can have one or more of Databases on the disk.
2727
Typically users have one directory called `grassdata` in their home
@@ -30,13 +30,13 @@ directory mounted as a network directory (network file system). For
3030
teams, a centralized GRASS DATABASE would be defined in a shared network
3131
file system (e.g. NFS).
3232

33-
GRASS GIS Databases can be safely copied or moved as any other
33+
GRASS Databases can be safely copied or moved as any other
3434
directories. Don't be confused with (relational) databases which are
35-
used in GRASS GIS to hold attribute data and might be part of the GRASS
36-
GIS Database. From user point of view, GRASS GIS Database with all its
35+
used in GRASS to hold attribute data and might be part of the GRASS
36+
Database. From user point of view, GRASS Database with all its
3737
data in it is similar to, e.g. PostGIS, database, as it stores all
3838
information inside in a specific format and is accessible by specific
39-
tools. GRASS GIS Databases is in GRASS GIS often called GISDBASE or
39+
tools. GRASS Database is often called GISDBASE or
4040
DATABASE.
4141

4242
## GRASS Projects
@@ -51,25 +51,25 @@ reference system.
5151

5252
GRASS projects can be safely copied or moved as any other directories.
5353
Compressed projects are usually what GRASS users exchange between each
54-
other when they want to share a lot of data. For example, GRASS GIS
54+
other when they want to share a lot of data. For example, GRASS
5555
sample data are provided as projects.
5656

5757
Note that a GRASS project used to be called *location* and this name has
5858
not been completely removed from code and documentation yet.
5959

6060
Users and programmers familiar with relational databases such as
6161
PostgreSQL can view projects as individual databases inside a storage
62-
area (the GRASS GIS Database). Mapsets in a project are like namespaces
62+
area (the GRASS Database). Mapsets in a project are like namespaces
6363
or schemas inside a database.
6464

6565
## GRASS Mapsets
6666

6767
Mapsets contains the actual data, mostly geospatial data, referred to as
68-
maps in GRASS GIS. Mapsets are a tool for organizing maps in a
68+
maps in GRASS. Mapsets are a tool for organizing maps in a
6969
transparent way as well as a tool for isolating different tasks to
7070
prevent data loss.
7171

72-
GRASS GIS is always connected to one particular mapset. GRASS GIS
72+
GRASS is always connected to one particular mapset. GRASS
7373
modules can create, modify, change, or delete a data only in the current
7474
mapset. By default, only the data from the current mapset and PERMANENT
7575
mapset are visible. Using [*g.mapsets*](g.mapsets.md) module or in GUI
@@ -100,11 +100,11 @@ that their coordinate reference systems (as reported by
100100
coordinate reference systems, it is recommended to use
101101
[*r.proj*](r.proj.md) or [*v.proj*](v.proj.md) to reproject the data.
102102
The files and directories should not be moved or modified directly, but
103-
only using GRASS GIS tools.
103+
only using GRASS tools.
104104

105105
## The role of the PERMANENT Mapset
106106

107-
When creating a new project, GRASS GIS automatically creates a special
107+
When creating a new project, GRASS automatically creates a special
108108
mapset called PERMANENT where the core data for the project are stored.
109109

110110
Since the maps in PERMANENT mapset are visible from all the other
@@ -119,7 +119,7 @@ mapset by the other users. The PERMANENT mapset is useful for providing
119119
general spatial data (e.g. an elevation model), accessible but
120120
write-protected to all users who are working with the same GRASS project
121121
as the database owner. To manipulate or add data to PERMANENT, the owner
122-
can start GRASS GIS and choose the relevant project and the PERMANENT
122+
can start GRASS and choose the relevant project and the PERMANENT
123123
mapset.
124124

125125
The PERMANENT mapset also contains the `DEFAULT_WIND` file which holds
@@ -129,7 +129,7 @@ have the option of switching back to the default region at any time.
129129

130130
## Importing, exporting and linking data
131131

132-
GRASS GIS works only with data which are imported into a GRASS Database,
132+
GRASS works only with data which are imported into a GRASS Database,
133133
so all data needs to be imported, e.g. by [*r.in.gdal*](r.in.gdal.md) or
134134
highly convenient [*r.import*](r.import.md), before the actual analysis.
135135
Data in GRASS Datable can be exported using for example
@@ -149,14 +149,14 @@ raster maps. Similarly for newly created maps,
149149
where the actual data will be stored, however in GRASS Database the data
150150
will be created as standard maps.
151151

152-
## Starting GRASS GIS
152+
## Starting GRASS
153153

154-
After launching GRASS GIS for the first time, the GUI opens in a default
154+
After launching GRASS for the first time, the GUI opens in a default
155155
project `world_latlong_wgs84`. From there a new project can be created.
156156

157-
![GRASS GIS GUI after first start](grass_start.png)
157+
![GRASS GUI after first start](grass_start.png)
158158

159-
GRASS GIS can be also started with a given database, project and mapset
159+
GRASS can be also started with a given database, project and mapset
160160
from the command line. For example, the following will start in a given
161161
mapset with only command line interface:
162162

doc/howto_release.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to release GRASS GIS binaries and source code
1+
# How to release GRASS binaries and source code
22

33
## Assumptions
44

@@ -80,7 +80,7 @@ For a release, change the version after the RC cycle to an official release:
8080
```
8181

8282
The script will compute the correct version string and print a message
83-
containing it into the terminal (e.g., "version: GRASS GIS 3.5.0RC1").
83+
containing it into the terminal (e.g., "version: GRASS 3.5.0RC1").
8484

8585
Commit with a commit message suggested by the script, e.g.:
8686

@@ -152,7 +152,7 @@ stored for annotated tags including a date; message is suggested by the
152152
`./utils/update_version.py` script):
153153

154154
```bash
155-
git tag $TAG -a -m "GRASS GIS $VERSION"
155+
git tag $TAG -a -m "GRASS $VERSION"
156156
```
157157

158158
List all tags (annotated will be at the top of both lists):

0 commit comments

Comments
 (0)