Skip to content

Commit

Permalink
doc: Add .html files back
Browse files Browse the repository at this point in the history
HTML will be in place as long as needed, but the primary, canonical file is the Markdown file.

It does not touch r.landscape.evol which already has documentation in Markdown.
  • Loading branch information
wenzeslaus committed Feb 19, 2025
1 parent 4291111 commit 9c03296
Show file tree
Hide file tree
Showing 486 changed files with 49,026 additions and 0 deletions.
45 changes: 45 additions & 0 deletions src/db/db.join/db.join.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<h2>DESCRIPTION</h2>

<em>db.join</em> joins the content of one attribute table into another
attribute table through common attributes.

<h2>NOTES</h2>

<em>db.join</em> is a front-end to <em>db.execute</em> to allow easier usage.

The attribute table must be stored in a SQL database (SQLite, PostgreSQL,
MySQL, ODBC, ...). The DBF backend is not supported. Tables can be
imported with <em>db.in.ogr</em>.

<h2>EXAMPLES</h2>


<div class="code"><pre>
# join soils_legend into mysoils attribute table
db.join mysoils col=label otable=soils_legend ocol=shortname

# verification of join
db.select mysoils
cat|label|id|shortname|longname
1|Aab|||
2|Ba|2|Ba|Barnum silt loam
3|Bb|3|Bb|Barnum silt loam, channeled
4|BcB|4|BcB|Boneek silt loam, 2 to 6
5|BcC|5|BcC|Boneek silt loam, 6 to 9
...
</pre></div>

<h2>SEE ALSO</h2>

<em>
<a href="https://grass.osgeo.org/grass-stable/manuals/db.execute.html">db.execute</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/db.in.ogr.html">db.in.ogr</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/db.select.html">db.select</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/v.db.join.html">v.db.join</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/v.db.update.html">v.db.update</a><br>
<a href="https://grass.osgeo.org/grass-stable/manuals/sql.html">GRASS SQL interface</a>
</em>

<h2>AUTHOR</h2>

Markus Neteler
127 changes: 127 additions & 0 deletions src/display/d.explanation.plot/d.explanation.plot.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<h2>DESCRIPTION</h2>

<em>d.explantion.plot</em> creates a plot of rasters and their relations
which can serve as an explanation of a raster operation performed by
a module or function.

<p>
Up to four rasters are supported. The default operators assume rasters to
have the following relation:

<p><em>
a + b -> c
</em></p>


<h2>EXAMPLES</h2>

<h3>Example using generated data</h3>

In Bash:

<div class="code"><pre>
g.region n=99 s=0 e=99 w=0 rows=3 cols=3
r.mapcalc expression="a = rand(0., 5)" seed=1
r.mapcalc expression="b = rand(0., 5)" seed=2
r.mapcalc expression="c = rand(0., 5)" seed=3
r.series input=a,b,c output=d method=average
</pre></div>

In Python:

<div class="code"><pre>
import grass.jupyter as gj
plot = gj.Map(use_region=True, width=700, height=700)
plot.d_background(color="white")
plot.run("d.explanation.plot", a="a", b="b", c="c", d="d", operator_font="FreeMono:Regular")
plot.show()
</pre></div>

<center>
<img src="d_explanation_plot_with_r_series.png">
<p><em>Figure: Resulting image for r.series</em></p>
</center>

<h3>Example using artificial data</h3>

<div class="code"><pre>
r.in.ascii input=- output=input_1 &lt;&lt;EOF
north: 103
south: 100
east: 103
west: 100
rows: 3
cols: 3
5 * 9
* 5 *
* 5 5
EOF
r.in.ascii input=- output=input_2 &lt;&lt;EOF
north: 103
south: 100
east: 103
west: 100
rows: 3
cols: 3
3 4 4
2 2 2
2 1 1
EOF
r.colors map=input_1,input_2 color=viridis
g.region raster=input_1
r.patch input=input_1,input_2 output=result
d.mon wx0 width=400 height=400 output=r_patch.png
d.explanation.plot a=input_1 b=input_2 c=result
</pre></div>

<center>
<img src="d_explanation_plot.png">
<p><em>Figure: Resulting image for r.patch</em></p>
</center>

<h2>KNOWN ISSUES</h2>

<ul>
<li>
Issue <a href="https://trac.osgeo.org/grass/ticket/3381">#3381</a>
prevents d.rast.num to be used with <tt>d.mon cairo</tt>,
so <tt>d.mon wx0</tt> needs to be used with this module.
Using environmental variables for rendering directly or
using tools such as <em>Map</em> from <em>grass.jupyter</em>
avoids the issues.
</li>
<li>
Issue <a href="https://trac.osgeo.org/grass/ticket/3382">#3382</a>
prevents usage of centered text with <tt>d.mon wx0</tt>, so the
hardcoded values for text does not work perfectly.
</li>
<li>
Issue <a href="https://trac.osgeo.org/grass/ticket/3383">#3383</a>
prevents d.rast.num to be saved to the image with
<tt>d.mon wx0</tt>, taking screenshot is necessary
(with a powerful screenshot tool, this also
addresses the copping issue below).
</li>
<li>
The size of the display must be square to have rasters and their
cells as squares, e.g., <tt>d.mon wx0 width=400 height=400</tt>
must be used. The image needs to be cropped afterwards,
e.g. using ImageMagic's <tt>mogrify -trim image.png</tt>.
</li>
</ul>


<h2>SEE ALSO</h2>

<em>
<a href="https://grass.osgeo.org/grass-stable/manuals/g.region.html">g.region</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/d.frame.html">d.frame</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/d.rast.num.html">d.rast.num</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/d.grid.html">d.grid</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/d.mon.html">d.mon</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/v.mkgrid.html">v.mkgrid</a>
</em>

<h2>AUTHOR</h2>

Vaclav Petras, <a href="https://geospatial.ncsu.edu/geoforall/">NCSU GeoForAll Lab</a>
97 changes: 97 additions & 0 deletions src/display/d.frame/d.frame.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<h2>DESCRIPTION</h2>

<em>d.frame</em> manages display frames on the current user's graphics
monitor. Graphics are displayed in rectangular frames on whatever
graphics monitor the user is currently directing GRASS display output
to (defined by <em><a href="https://grass.osgeo.org/grass-stable/manuals/d.mon.html">d.mon</a></em> module). These
frames are created and managed with this module.

<p>
Note that GRASS frame contents <em>are not</em> retained when one
frame covers another. You cannot shuffle frames from top to bottom and
then back again. They simply define rectangular areas on the screen
where subsequent drawing will occur.

<h2>NOTES</h2>

The coordinates for the <b>at</b> option are stated in the form
<em>top,bottom,left,right</em> values are in percent. The upper-left
corner of the graphics monitor always is at location 0,0 while the
monitor's lower-right corner is always at 100,100.

<p>
If the user has created multiple display frames that overlap one another,
whatever the user displays in the active frame will overwrite
those portions of the underlying frame where these frames overlap.

<p>
<b>Important note:</b> This version of <em>d.frame</em> works only
with GRASS 7.0. Further versions of GRASS come with their own
built-in <em>d.frame</em> module.

<h2>EXAMPLE</h2>

<div class="code"><pre>
# start a new graphics monitor, the data will be rendered to
# /tmp/map.png image output file of size 600x540px
d.mon cairo out=/tmp/map.png width=600 height=540 --o

# set up region
g.region raster=elevation

# remove all frames and erase the current graphics monitor
d.frame -e

# create a first frame and display 'landuse96_28m' raster map including text label
d.frame -c frame=first at=0,50,0,50
d.rast landuse96_28m
d.text text='Landuse' bgcolor=220:220:220 color=black size=6

# create a second frame and display 'streams' vector map
d.frame -c frame=second at=0,50,50,100
d.vect streams color=blue
d.text text='Streams' bgcolor=220:220:220 color=black size=6

# create a third frame and display 'elevation' raster map including text label and scale
d.frame -c frame=third at=50,100,0,50
d.rast elevation
d.text text='Elevation' bgcolor=220:220:220 color=black size=6
d.barscale at=0,10 style=line bgcolor=none

# create a fourth frame and display RGB composition map including text label
d.frame -c frame=fourth at=50,100,50,100
d.rgb red=lsat7_2002_30 green=lsat7_2002_20 blue=lsat7_2002_10
d.text text='RGB true colors' bgcolor=220:220:220 color=black size=6

# release the current graphics monitor
d.mon -r
</pre></div>

<center>
<img src="d_frame.png" alt="d.frame example"><br>
<em>Figure: d.frame example</em>
</center>

<h2>SEE ALSO</h2>

<em>
<a href="https://grass.osgeo.org/grass-stable/manuals/d.erase.html">d.erase</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/d.info.html">d.info</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/d.mon.html">d.mon</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/d.redraw.html">d.redraw</a>
</em>

<p>
<a href="https://grass.osgeo.org/grass-stable/manuals/variables.html#list-of-selected-grass-environment-variables-for-rendering">GRASS environment variables for
rendering</a> (GRASS_RENDER_FRAME)

<h2>AUTHORS</h2>

Martin Landa, Czech Technical University in Prague, Czech Republic

<p>
Based on <em>d.frame</em> from GRASS 6:<br>
James Westervelt, U.S. Army Construction Engineering Research
Laboratory<br>
Michael Shapiro, U.S. Army Construction Engineering
Research Laboratory
31 changes: 31 additions & 0 deletions src/display/d.mon2/d.mon2.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<h2>DESCRIPTION</h2>

This is just a little experiment to see if we can make the ximgview,
wximgview, and wxpyimgview programs a bit simpler to start up.
<p>

Add this to your <tt>~/.grass.bashrc</tt> file:

<div class="code"><pre>
if [ `echo "$GRASS_VERSION" | cut -f1 -d.` -eq 7 ] ; then
alias d.mon='eval `d.mon.py -b`'
fi
</pre></div>

<p>
By default the temporary file will be stored in $MAPSET/.tmp/ and cleared
at the end of the session. You can put it somewhere else with the
<b>tempfile</b> option. For example, when working remotely with
PuTTY (ssh without tunnelled X) + Apache:

<div class="code"><pre>
alias d.mon='eval `d.mon.py -b handler=none tempfile=/var/www/grassmap.png`'
</pre></div>

then just hit reload in your web browser whenever a refresh is needed.


<h2>AUTHOR</h2>

Hamish Bowman<br>
Dunedin, New Zealand
Loading

0 comments on commit 9c03296

Please sign in to comment.