Skip to content

Commit

Permalink
Merge remote-tracking branch 'fork/mask-env-var' into mask-env-var
Browse files Browse the repository at this point in the history
  • Loading branch information
wenzeslaus committed Feb 25, 2025
2 parents 048918c + 204bab7 commit 327877e
Show file tree
Hide file tree
Showing 36 changed files with 296 additions and 181 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build_ubuntu-22.04_without_x.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ export INSTALL_PREFIX=$1
./configure \
--enable-largefile \
--prefix="$INSTALL_PREFIX/" \
--with-blas \
--without-blas \
--without-lapack \
--with-bzlib \
--with-cxx \
--with-fftw \
--with-freetype \
--with-freetype-includes="/usr/include/freetype2/" \
--with-geos \
--with-lapack \
--with-netcdf \
--with-pdal \
--with-proj-share=/usr/share/proj \
Expand Down
17 changes: 7 additions & 10 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ jobs:
path: grass-addons

- name: Compile addons
continue-on-error: true
run: |
./grass-addons/utils/cronjobs_osgeo_lxd/compile_addons_git.sh \
"$MAJOR" \
Expand All @@ -105,19 +104,17 @@ jobs:
echo MKDOCS_DIR="$(grass --config path)/docs/mkdocs" >> "$GITHUB_ENV"
- name: Move from build to target directory
continue-on-error: true
run: |
mkdir -p "$MKDOCS_DIR/source/addons"
mv addons-build-dir/docs/md/source/* "$MKDOCS_DIR/source/addons"
mkdir "$MKDOCS_DIR/source/addons"
mv -v addons-build-dir/docs/md/source/* "$MKDOCS_DIR/source/addons"
- name: Rebuild keywords
continue-on-error: true
run: |
export ARCH="linux"
export ARCH="$(grass --config arch)"
export ARCH_DISTDIR="$(grass --config path)"
export TOP_DOCS_DIR="${ARCH_DISTDIR}/docs"
export VERSION_NUMBER="$VERSION"
grass --tmp-project XY --exec python grass/man/build_keywords.py "$TOP_DOCS_DIR" "$MKDOCS_DIR/source/addons"
grass --tmp-project XY --exec \
python grass/man/build_keywords.py md "$MKDOCS_DIR/source" "$MKDOCS_DIR/source/addons"
- name: Get mkdocs
run: |
Expand All @@ -137,8 +134,8 @@ jobs:
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
name: grass-addon-build-logs
if-no-files-found: warn
path: addons-build-dir/docs/logs
if-no-files-found: error
path: addons-build-dir/logs
retention-days: 3

- name: Make the result available
Expand Down
46 changes: 21 additions & 25 deletions display/d.font/d.font.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,27 @@ will run non-interactively. Alternately, the user can simply type
**d.font** on the command line; in this case, the program will prompt
the user for a display text font type.

**Parameter:**

**font=***name*
Name of a font type, from among the font types italicized below.
Default: *romans*
Options: (italized)
*cyrilc* Cyrillic
*gothgbt* Gothic Great Britain triplex
*gothgrt* Gothic German triplex
*gothitt* Gothic Italian triplex
*greekc* Greek complex
*greekcs* Greek complex script
*greekp* Greek plain
*greeks* Greek simplex
*italicc* Italian complex
*italiccs* Italian complex small
*italict* Italian triplex
*romanc* Roman complex
*romancs* Roman complex small
*romand* Roman duplex
*romanp* Roman plain
*romans* Roman simplex
*romant* Roman triplex
*scriptc* Script complex
*scripts* Script simplex
Font options (italized):

- *cyrilc*: Cyrillic
- *gothgbt*: Gothic Great Britain triplex
- *gothgrt*: Gothic German triplex
- *gothitt*: Gothic Italian triplex
- *greekc*: Greek complex
- *greekcs*: Greek complex script
- *greekp*: Greek plain
- *greeks*: Greek simplex
- *italicc*: Italian complex
- *italiccs*: Italian complex small
- *italict*: Italian triplex
- *romanc*: Roman complex
- *romancs*: Roman complex small
- *romand*: Roman duplex
- *romanp*: Roman plain
- *romans*: Roman simplex
- *romant*: Roman triplex
- *scriptc*: Script complex
- *scripts*: Script simplex

## NOTES

Expand Down
6 changes: 3 additions & 3 deletions display/d.legend/d.legend.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ obscure. When using **lines**, auto-scaled text similar to "4 of 16
categories" will be placed at the bottom of the legend.

The **thin** option sets the thinning factor. For raster maps with a 0th
category, **thin=***10* gives cats \[0,10,20,...\]. For raster maps
starting at category 1, **thin=***10* gives cats \[1,11,21,...\].
category, **thin**=*10* gives cats \[0,10,20,...\]. For raster maps
starting at category 1, **thin**=*10* gives cats \[1,11,21,...\].

The **use** option lets the user create a legend made up of arbitrary
category values. e.g. **use=***1000,100,10,0,-10,-100,-1000*
category values. e.g. **use**=*1000,100,10,0,-10,-100,-1000*

The **range** option lets the user define the minimum and maximum
categories to be used in the legend. It may also be used to define the
Expand Down
11 changes: 7 additions & 4 deletions general/g.gisenv/g.gisenv.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ MAPSET=/user1
GUI=gui
```

If the user specifies a **get=***variable_name* on the command line
If the user specifies a **get**=*variable_name* on the command line

```sh
g.gisenv MAPSET
Expand All @@ -36,7 +36,8 @@ While other variables may be associated with each GRASS session (e.g.,
GRASS_GUI, GIS_LOCK, and other variables), those stated below are
essential.

*GISDBASE*
### GISDBASE

The *GISDBASE* is a directory in which all users' GRASS data are stored.
Within the *GISDBASE*, data are segregated into subdirectories (called
"projects") based on the map coordinate system used and the geographic
Expand All @@ -45,7 +46,8 @@ subdirectories called "mapsets"; each "mapset" stores "data base
elements" - the directories (e.g., the `cell`, `cellhd`, `vector`, etc.,
directories) in which GRASS data files are actually stored.

*LOCATION_NAME*
### LOCATION_NAME

The user must choose to work with the data under a single GRASS project
(previously called "location") within any given GRASS session; this
project is then called the *current GRASS project*, and is specified by
Expand All @@ -58,7 +60,8 @@ under the same GRASS *LOCATION_NAME* (and/or within the same *MAPSET*)
must use the same coordinate system and typically fall within the
boundaries of the same geographic region.

*MAPSET*
### MAPSET

Each "mapset" contains a set of maps relevant to the *LOCATION_NAME*
directory in which it appears. Each *LOCATION_NAME* can contain multiple
mapsets. (Mapsets which fall under the same *LOCATION_NAME* all contain
Expand Down
12 changes: 4 additions & 8 deletions general/g.proj/g.proj.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,22 @@ proprietary GIS. In addition, if one of the parameters *georef*, *wkt*,
project, the CRS information is imported from an external source as
follows:

georef=*filename*
*g.proj* attempts to invoke GDAL and OGR in turn to read a georeferenced
- With **georef**=*filename* g.proj attempts to invoke GDAL and OGR in turn to read a georeferenced
file *filename*. The CRS information will be read from this file. If the
file is not georeferenced or cannot be read, XY (unprojected) will be
used.

wkt=*filename* or **-**
The file *filename* should contain a CRS description in WKT format with
- When using **wkt**=*filename*, the file *filename* should contain a CRS description in WKT format with
or without line-breaks (e.g. a '.prj' file). If **-** is given for the
filename, the WKT description will be read from stdin rather than a
file.

proj4=*description* or **-**
*description* should be a CRS description in [PROJ](https://proj.org/)
- **proj4**=*description* should be a CRS description in [PROJ](https://proj.org/)
format, enclosed in quotation marks if there are any spaces. If **-** is
given for *description*, the PROJ description will be read from stdin
rather than as a directly-supplied command-line parameter.

epsg=*number*
*number* should correspond to the index number of a valid co-ordinate
- **epsg**=*number* should correspond to the index number of a valid co-ordinate
system in the [EPSG database](https://epsg.org/search/by-name). EPSG
code support is based upon a local copy of the GDAL CSV co-ordinate
system and datum information files, stored in the directory
Expand Down
24 changes: 13 additions & 11 deletions general/g.region/g.region.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ use the current geographic region settings.

## DEFINITIONS

**Region:**
### Region

In GRASS, a *region* refers to a geographic area with some defined
boundaries, based on a specific map coordinate system and map
projection. Each region also has associated with it the specific
Expand All @@ -34,7 +35,8 @@ Typically all raster and display modules are affected by the current
region settings, but not vector modules. Some special modules diverge
from this rule, for example raster import modules and *v.in.region*.

**Default Region:**
### Default Region

Each GRASS project (previously called location) has a fixed geographic
region, called the default geographic region (stored in the region file
`DEFAULT_WIND` under the special mapset `PERMANENT`), that defines the
Expand All @@ -45,13 +47,15 @@ to the default region with the **-d** flag. The default region is
initially set when the project is first created and can be reset using
the **-s** flag.

**Current Region:**
### Current Region

Each mapset has a current geographic region. This region defines the
geographic area in which all GRASS displays and raster analyses will be
done. Raster data will be resampled, if necessary, to meet the cell
resolutions of the current geographic region setting.

**Saved Regions:**
### Saved Region

Each GRASS MAPSET may contain any number of pre-defined, and named,
geographic regions. These region definitions are stored in the user's
current mapset location under the `windows` directory (also referred to
Expand Down Expand Up @@ -101,24 +105,22 @@ always updated unless **-u** was specified.

### Additional parameter information

**zoom=***name*
Shrink current region settings to the smallest region encompassing all
Option **zoom** shrinks current region settings to the smallest region encompassing all
non-NULL data in the named raster map layer that fall inside the user's
current region. In this way you can tightly zoom in on isolated clumps
within a bigger map.

If the user also includes the **raster=***name* option on the command
line, **zoom=***name* will set the current region settings to the
If the user also includes the **raster** option on the command
line, **zoom** will set the current region settings to the
smallest region encompassing all non-NULL data in the named **zoom** map
that fall inside the region stated in the cell header for the named
**raster** map.

**align=***name*
Set the current resolution equal to that of the named raster map, and
Option **align** sets the current resolution equal to that of the provided raster map, and
align the current region to a row and column edge in the named map.
Alignment only moves the existing region edges outward to the edges of
the next nearest cell in the named raster map - not to the named map's
edges. To perform the latter function, use the **raster=***name* option.
edges. To perform the latter function, use the **raster**=*name* option.

## EXAMPLES

Expand Down
8 changes: 4 additions & 4 deletions imagery/i.cca/i.cca.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ the output raster map name specified on the command line.

### Parameters

**group=***name*
**group**=*name*
Name of the [imagery](i.group.md) group to which the raster band files
used belong.

**subgroup=***name*
**subgroup**=*name*
Name of the [imagery](i.group.md) subgroup to which the raster band
files used belong.

**signature=***name*
**signature**=*name*
Name of an ASCII file containing spectral signatures.

**output=***name*
**output**=*name*
Output raster map prefix name. The output raster map layer names are
built by appending a ".1", ".2", etc. onto the *output* name specified
by the user.
Expand Down
26 changes: 6 additions & 20 deletions imagery/i.gensigset/i.gensigset.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,7 @@ An usage example can be found in [i.smap](i.smap.md) documentation.

### Parameters

**trainingmap=***name*
ground truth training map

This raster layer, supplied as input by the user, has some of its pixels
The **trainingmap** raster layer, supplied as input by the user, has some of its pixels
already classified, and the rest (probably most) of the pixels
unclassified. Classified means that the pixel has a non-zero value and
unclassified means that the pixel has a zero value.
Expand All @@ -46,31 +43,20 @@ to define the areas representative of the classes in the image.
At present, there is no fully-interactive tool specifically designed for
producing this layer.

**group=***name*
imagery group

This is the name of the group that contains the band files which
Option **group** is the name of the group that contains the band files which
comprise the image to be analyzed. The *[i.group](i.group.md)* command
is used to construct groups of raster layers which comprise an image.

**subgroup=***name*
subgroup containing image files

This names the subgroup within the group that selects a subset of the
Option **subgroup** names the subgroup within the group that selects a subset of the
bands to be analyzed. The *[i.group](i.group.md)* command is also used
to prepare this subgroup. The subgroup mechanism allows the user to
select a subset of all the band files that form an image.

**signaturefile=***name*
resultant signature file

This is the resultant signature file (containing the means and
Option **signaturefile** is the resultant signature file (containing the means and
covariance matrices) for each class in the training map that is
associated with the band files in the subgroup selected.

**maxsig=***value*
maximum number of sub-signatures in any class
default: 5
Option **maxsig** is the maximum number of sub-signatures in any class (default: 5).

The spectral signatures which are produced by this program are "mixed"
signatures (see [NOTES](#notes)). Each signature contains one or more
Expand Down Expand Up @@ -115,7 +101,7 @@ data. The approximate maximum likelihood estimates of the mean and
covariance of the subclasses are computed using the expectation
maximization (EM) algorithm (Dempster, 1977 and Redner, 1984).

## WARNINGS
### WARNINGS

If warnings like this occur, reducing the remaining classes to 0:

Expand Down
10 changes: 5 additions & 5 deletions imagery/i.smap/i.smap.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,23 @@ to use SMAP estimation (see NOTES below).

### Parameters

**group=***name*
**group**=*name*
imagery group
The imagery group that defines the image to be classified.

**subgroup=***name*
**subgroup**=*name*
imagery subgroup
The subgroup within the group specified that specifies the subset of the
band files that are to be used as image data to be classified.

**signaturefile=***name*
**signaturefile**=*name*
imagery signaturefile
The signature file that contains the spectral signatures (i.e., the
statistics) for the classes to be identified in the image. This
signature file is produced by the program
*[i.gensigset](i.gensigset.md)* (see NOTES below).

**blocksize=***value*
**blocksize**=*value*
size of submatrix to process at one time
default: 1024
This option specifies the size of the "window" to be used when reading
Expand All @@ -69,7 +69,7 @@ region of the image.
The submatrix size has no effect on the performance of the ML
segmentation method.

**output=***name*
**output**=*name*
output raster map.
The name of a raster map that will contain the classification results.
This new raster map layer will contain categories that can be related to
Expand Down
Loading

0 comments on commit 327877e

Please sign in to comment.