[GRASS-dev] [GRASS GIS] #386: Thematic grouping of grass modules in the command line

GDAL · November 30, 2008, 8:26pm

#386: Thematic grouping of grass modules in the command line
------------------------------------+---------------------------------------
Reporter: nikos | Owner: grass-dev@lists.osgeo.org
Type: enhancement | Status: new
Priority: minor | Milestone: 6.4.0
Component: default | Version: unspecified
Keywords: grouping grass modules | Platform: Unspecified
Cpu: Unspecified |
------------------------------------+---------------------------------------
Some weeks ago I started grouping the grass (raster) modules in order to
have a rough overview table of "what is there to use and for what". I find
the grouping of the modules in the GUI good. But I would like some helpful
commands in the CL.

1. Is it feasible to have some sort of another (deeper) level of grouping
(of the grass-modules)?[[BR]]Something like a "thematic" grouping (see
atached .csv file).

2. Would it be useful to have commands that will list available modules
for a specific "group"? For example, I want to get listed all modules that
are related directly with "landscape analysis" or to know which modules
are available for "statistical analysis".

** The following naming(s) are just ideas... **

For example:

# listing "groups of modules"[[BR]]
g.list -c(ategories)[[BR]]

import[[BR]]
metadata manipulation[[BR]]
queries[[BR]]
categories/classes/codes[[BR]]
editing[[BR]]
pre-processing[[BR]]
resampling[[BR]]
conversion[[BR]]
processing[[BR]]
topographic analysis (+ surface + volume...)[[BR]]
statistics[[BR]]
irradiation[[BR]]
agro(...)[[BR]]
hydrological modelling[[BR]]
landscape analysis[[BR]]
validation[[BR]]
export[[BR]]

# listing the "statistics" group[[BR]]
g.listmod -stat(istics)[[BR]]
# etc. Use your imagination & logic for more names/groups

3. What speaks against those ideas?

Kind Regards, Nikos

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386>
GRASS GIS <http://grass.osgeo.org>

GDAL · November 30, 2008, 9:09pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@lists.osgeo.org
      Type: enhancement | Status: new
  Priority: minor | Milestone: 6.4.0
Component: default | Version: unspecified
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Comment (by marisn):

This idea is not new and it's partly implemented as keywords. Many GRASS
modules are universal and thus keyword approach fits better. Only current
issue is lack of user-visible/friendly keyword list/search etc.
infrastructure.

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:1>
GRASS GIS <http://grass.osgeo.org>

GDAL · November 30, 2008, 9:12pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@lists.osgeo.org
      Type: enhancement | Status: new
  Priority: minor | Milestone: 6.4.0
Component: default | Version: unspecified
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Comment (by martinl):

Replying to [comment:1 marisn]:
> Only current issue is lack of user-visible/friendly keyword list/search
etc. infrastructure.

yes, such kind of search engine is part of wxGUI roadmap, any volunteer?

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:2>
GRASS GIS <http://grass.osgeo.org>

GDAL · December 1, 2008, 12:39am

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@lists.osgeo.org
      Type: enhancement | Status: new
  Priority: minor | Milestone: 6.4.0
Component: default | Version: unspecified
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Comment (by hamish):

Replying to [ticket:386 nikos]:
> 2. Would it be useful to have commands that will list available modules
for a specific "group"? For example, I want to get listed all modules that
are related directly with "landscape analysis" or to know which modules
are available for "statistical analysis".

e.g. the GUI menu grouping? (module names given in the status line)

Hamish

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/386#comment:3>
GRASS GIS <http://grass.osgeo.org>

GDAL · December 1, 2008, 1:32am

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@lists.osgeo.org
      Type: enhancement | Status: new
  Priority: minor | Milestone: 6.4.0
Component: default | Version: unspecified
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Comment (by nikos):

Replying to [comment:3 hamish]:
> Replying to [ticket:386 nikos]:
> > 2. Would it be useful to have commands that will list available
modules for a specific "group"? For example, I want to get listed all
modules that are related directly with "landscape analysis" or to know
which modules are available for "statistical analysis".
>
>
> e.g. the GUI menu grouping? (module names given in the status line)
>
>
> Hamish

Well, it's true the "groups" are there. Why starting from scratch? It will
also make easier the transition from the GUI to the CLI (for those who are
thirsty to learn to use the CL)

Though, I might file another ticket for a few changes concerning the
grouping of modules in the GUI's menu(s). It gives sometimes an
*overloaded* feeling.

Thanks to all for your time to respond.

Nikos

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:4>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 21, 2012, 7:43pm

#386: Thematic grouping of grass modules in the command line
------------------------------------+---------------------------------------
Reporter: nikos | Owner: grass-dev@…
Type: enhancement | Status: new
Priority: minor | Milestone: 6.4.4
Component: Docs | Version: unspecified
Keywords: grouping grass modules | Platform: Unspecified
Cpu: Unspecified |
------------------------------------+---------------------------------------
Changes (by neteler):

* component: Default => Docs
* milestone: 6.4.0 => 6.4.4

Comment:

See this prototype for topic oriented command grouping using
keyword extraction:

http://gis.cri.fmach.it/download/grass_html/topics.html

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:5>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 27, 2012, 3:37pm

#386: Thematic grouping of grass modules in the command line
------------------------------------+---------------------------------------
Reporter: nikos | Owner: grass-dev@…
Type: enhancement | Status: new
Priority: minor | Milestone: 6.4.4
Component: Docs | Version: unspecified
Keywords: grouping grass modules | Platform: Unspecified
Cpu: Unspecified |
------------------------------------+---------------------------------------

Comment(by lucadelu):

I committed in r52931 a python script to fix this for grass7. It works
with the second keyword of documentation, maybe we should use also the
third.
It is impossible to backported this script to grass6 so or we change the
milestone to 7.0.0 and sign as fixed or someone as to convert it to bash
script. You can see a preview here

http://geodati.fmach.it/grass70/topics.html

next week you should see it also in the main grass70 documentation.

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:6>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 27, 2012, 4:09pm

#386: Thematic grouping of grass modules in the command line
------------------------------------+---------------------------------------
Reporter: nikos | Owner: grass-dev@…
Type: enhancement | Status: new
Priority: minor | Milestone: 6.4.4
Component: Docs | Version: unspecified
Keywords: grouping grass modules | Platform: Unspecified
Cpu: Unspecified |
------------------------------------+---------------------------------------

Comment(by martinl):

Replying to [comment:5 neteler]:
> See this prototype for topic oriented command grouping using
> keyword extraction:
>
> http://gis.cri.fmach.it/download/grass_html/topics.html

cool! very useful... Martin

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:7>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 28, 2012, 3:11pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: closed
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: unspecified
Resolution: fixed | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Changes (by neteler):

  * status: new => closed
  * resolution: => fixed
  * milestone: 6.4.4 => 7.0.0

Comment:

It is now part of standard GRASS 7:

http://grass.osgeo.org/grass70/manuals/html70_user/topics.html

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:8>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 28, 2012, 3:39pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: reopened
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: unspecified
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Changes (by lucadelu):

* status: closed => reopened
* resolution: fixed =>

Comment:

Do you think that Topics link should be also in the bottom of every
command as "Main index"/"Full index" ?

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:9>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 9:16am

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: closed
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: fixed | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Changes (by neteler):

  * status: reopened => closed
  * version: unspecified => svn-trunk
  * resolution: => fixed

Comment:

Replying to [comment:9 lucadelu]:
> Do you think that Topics link should be also in the bottom of every
command as "Main index"/"Full index" ?

Yes. I have implemented it.

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:10>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 9:25am

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: closed
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: fixed | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by hamish):

Hi there,

How about splitting it up into 3 columns?

To get the balance correct it would have to know the number of elements in
the list before it began writing the page.

If you sorted alphabetically by row first, maybe you don't have to know
that before hand, just do a 'carriage return' maneuver after every n'th
column, then pad empty cells at the end of the table as needed.

thanks,
Hamish

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/386#comment:11>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 11:17am

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: closed
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: fixed | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by mlennert):

I think such as list is very useful, but the result is still quite
unsatisfactory at this point. E.g.

* database only links to v.db.* modules, none of the db.* modules[[BR]]

* imagery only lists r.in.aster[[BR]]

* raster links to a series of diverse modules, none of them r.*[[BR]]

* interpolation only links to t.rast.gapfill[[BR]]

etc

I guess this means that many modules do not have the right (or any?)
keywords. But IMHO, as much as I like the idea, I'm afraid that in its
current state this list might be counterproductive for new users. I
definitely would not recommend my students to use it right now when trying
to find modules by topics.

Moritz

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/386#comment:12>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 11:33am

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: reopened
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Changes (by neteler):

* status: closed => reopened
* resolution: fixed =>

Comment:

Replying to [comment:12 mlennert]:
> I think such as list is very useful, but the result is still quite
unsatisfactory at this point. E.g.
>
> * database only links to v.db.* modules, none of the db.* modules[[BR]]

As written, the current mechanism is based on the second keyword. Each
topic corresponds to this. The db.* have: "attribute table" there, while
the v.db.* have "database". It is a trivial change to reorder this, just
some agreement is needed first.

> * imagery only lists r.in.aster[[BR]]

Fixed in r , now it results in "Import".

> * raster links to a series of diverse modules, none of them r.*[[BR]]

Right, all have the wrong second keyword. Working on it.

> * interpolation only links to t.rast.gapfill[[BR]]

The others under "surface". This requires some more discussion how to
classify them.

> etc
>
> I guess this means that many modules do not have the right (or any?)
keywords. But IMHO, as much as I like the idea, I'm afraid that in its
current state this list might be counterproductive for new users. I
definitely would not recommend my students to use it right now when trying
to find modules by topics.

Ok, it exists for a few days only - tell them to wait a week

Markus

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/386#comment:13>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 12:36pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: reopened
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by madi):

Ciao, would it be possible to include somehow also add-ons in the search?
this could be very useful as well. Thanks

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:14>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 12:39pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: reopened
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by martinl):

Replying to [comment:14 madi]:
> Ciao, would it be possible to include somehow also add-ons in the
search? this could be very useful as well. Thanks

probably yes, see auto-generated `modules.xml` (1) which contains keywords
tag.

Martin

(1) http://grass.osgeo.org/addons/grass7/modules.xml

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:15>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 1:04pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: reopened
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by neteler):

Replying to [comment:13 neteler]:
> Replying to [comment:12 mlennert]:
> > * database only links to v.db.* modules, none of the db.*
modules[[BR]]

Fixed in r52973m using "attribute table" everywhere since "database"
is already the first category.

> > * raster links to a series of diverse modules, none of them r.*[[BR]]
>
> Right, all have the wrong second keyword. Working on it.

Done.

> > * interpolation only links to t.rast.gapfill[[BR]]
>
> The others under "surface". This requires some more discussion how to
> classify them.

Remains open for discussion.

Updated list here:
http://grass.osgeo.org/grass70/manuals/html70_user/topics.html

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:16>
GRASS GIS <http://grass.osgeo.org>

GDAL · August 29, 2012, 3:47pm

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: reopened
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by mlennert):

Replying to [comment:16 neteler]:
> Replying to [comment:13 neteler]:
> > Replying to [comment:12 mlennert]:
> > > * database only links to v.db.* modules, none of the db.*
modules[[BR]]
>
> Fixed in r52973m using "attribute table" everywhere since "database"
> is already the first category.
>
> > > * raster links to a series of diverse modules, none of them
r.*[[BR]]
> >
> > Right, all have the wrong second keyword. Working on it.
>
> Done.
>
> > > * interpolation only links to t.rast.gapfill[[BR]]
> >
> > The others under "surface". This requires some more discussion how to
> > classify them.
>

Thanks for all the work on the keywords. At least now things are more
consistent. I would have looked first for database, and would probably not
have thought of looking for "attribute table" as a keyword, but that's me.
What this does raise as a question is why do we have to limit ourselves to
one keyword per module. Can't you just create this list with all the key
words, with modules appearing under different keywords ? Thus you multiply
the chance of people finding the module.

Moritz

P.S. Sorry if my comment about my students using the list sounded harsh.
I'm aware that this is a new effort, but was a bit surprised that it was
published so quickly on the web site. Then again, GRASS7 _is_ a
development version.

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/386#comment:17>
GRASS GIS <http://grass.osgeo.org>

neteler · August 30, 2012, 8:27am

(moving to grass-dev to not clutter the ticket too much)

On Wed, Aug 29, 2012 at 5:47 PM, GRASS GIS <trac@osgeo.org> wrote:

#386: Thematic grouping of grass modules in the command line

...

Comment(by mlennert):

...

Thanks for all the work on the keywords. At least now things are more
consistent. I would have looked first for database, and would probably not
have thought of looking for "attribute table" as a keyword, but that's me.

Maybe me too. However, for database we have already
http://grass.osgeo.org/grass70/manuals/html70_user/database.html

No idea what's better.

What this does raise as a question is why do we have to limit ourselves to
one keyword per module.

It si simply the current technical solution.

Can't you just create this list with all the key
words, with modules appearing under different keywords ? Thus you multiply
the chance of people finding the module.

I am not sure: this would lead in the worse case to 400 topic pages.
This is why I (additionally) want the searchable manual (e.g. via sphinx).

P.S. Sorry if my comment about my students using the list sounded harsh.

No worries

I'm aware that this is a new effort, but was a bit surprised that it was
published so quickly on the web site. Then again, GRASS7 _is_ a
development version.

Right - and remember: as soon as manual changes reach the SVN,
they appear automagically on the Web since the manual is generated
from the weekly binary snapshot.

Markus

GDAL · March 27, 2014, 3:28am

#386: Thematic grouping of grass modules in the command line
--------------------------+-------------------------------------------------
  Reporter: nikos | Owner: grass-dev@…
      Type: enhancement | Status: reopened
  Priority: minor | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Resolution: | Keywords: grouping grass modules
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by wenzeslaus):

What needs to be done to close this ticket?

I suggest to revise original description and also create new tickets (or
update relevant existing tickets) if some of the ideas in discussion have
clear shape.

Currently we have Topics and Keywords index in manual:
* http://grass.osgeo.org/grass70/manuals/topics.html
* http://grass.osgeo.org/grass70/manuals/keywords.html

tickets with similar requests:
  * #645 link documentation to new GUI developments
  * #762 add menu location to help pages
  * #1203 explain command mapping to wxGUI menus

XML files in source code:
  * source:grass/trunk/gui/wxpython/xml/main_menu.xml
  * source:grass/trunk/gui/wxpython/xml/module_tree.xml
  * source:grass/trunk/gui/wxpython/xml/toolboxes.xml
  * (these follow definition
source:grass/trunk/gui/wxpython/xml/toolboxes.dtd)

and generated XML files:
* http://grass.osgeo.org/addons/grass7/modules.xml (only on addons
server)

There are some other XMLs but I don't think that they are important for
the discussion.

If you want to do extend the list above with details and examples, I
suggest to create a wiki page on Trac, e.g.
wiki:Toolboxes/GeneratingDocumentation.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/386#comment:18>
GRASS GIS <http://grass.osgeo.org>