[GRASS-dev] Add link to manual page on the addon wiki

GRASS GIS GRASS GIS developer
1

Currently on the http://grasswiki.osgeo.org/wiki/AddOns/GRASS7/ page the link to the source files are provided (for those uploaded to the grass gis addon svn).

Now that online manual pages of the addons are automatically created (very nice!), I was thinking that it might be useful for users to provide the link to these manual pages. This might be useful for users browsing the available addons on that wiki page.

I don’t mind doing that (for GRASS 7) if others think that it is a good idea. If so, is there a similar shortcut as for the source files, e.g.,: {{AddonManual|raster|addon_name|version=7}}

Paulo

2

On Sat, Jan 24, 2015 at 6:17 PM, Paulo van Breugel <p.vanbreugel@gmail.com>
wrote:

Currently on the http://grasswiki.osgeo.org/wiki/AddOns/GRASS7/ page the
link to the source files are provided (for those uploaded to the grass gis
addon svn).

Now that online manual pages of the addons are automatically created (very
nice!), I was thinking that it might be useful for users to provide the
link to these manual pages. This might be useful for users browsing the
available addons on that wiki page.

I don't mind doing that (for GRASS 7) if others think that it is a good
idea. If so, is there a similar shortcut as for the source files, e.g.,:
{{AddonManual|raster|addon_name|version=7}}

The situation now is unclear. There is the list on the wiki but also the
generated list at http://grass.osgeo.org/grass70/manuals/addons/

What about something like wiki just linking this list plus having list of
addons which are not in the official repository?

Paulo

_______________________________________________
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

3

On Sun, Jan 25, 2015 at 12:25 AM, Vaclav Petras <wenzeslaus@gmail.com>
wrote:

On Sat, Jan 24, 2015 at 6:17 PM, Paulo van Breugel <p.vanbreugel@gmail.com
> wrote:

Currently on the http://grasswiki.osgeo.org/wiki/AddOns/GRASS7/ page the
link to the source files are provided (for those uploaded to the grass gis
addon svn).

Now that online manual pages of the addons are automatically created
(very nice!), I was thinking that it might be useful for users to provide
the link to these manual pages. This might be useful for users browsing the
available addons on that wiki page.

I don't mind doing that (for GRASS 7) if others think that it is a good
idea. If so, is there a similar shortcut as for the source files, e.g.,:
{{AddonManual|raster|addon_name|version=7}}

The situation now is unclear. There is the list on the wiki but also the
generated list at http://grass.osgeo.org/grass70/manuals/addons/

That is true

What about something like wiki just linking this list plus having list of
addons which are not in the official repository?

Although nice to have this automatically generated list, I need to click on
each one to get a first impression what it is for (it is not always
possible to guess this from the name). I like the wiki page in that it
provide a very brief description / impression what the addons are about at
a glance.

Paulo

_______________________________________________
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

4

On Sat, Jan 24, 2015 at 6:33 PM, Paulo van Breugel <p.vanbreugel@gmail.com>
wrote:

On Sun, Jan 25, 2015 at 12:25 AM, Vaclav Petras <wenzeslaus@gmail.com>
wrote:

On Sat, Jan 24, 2015 at 6:17 PM, Paulo van Breugel <
p.vanbreugel@gmail.com> wrote:

Currently on the http://grasswiki.osgeo.org/wiki/AddOns/GRASS7/ page
the link to the source files are provided (for those uploaded to the grass
gis addon svn).

Now that online manual pages of the addons are automatically created
(very nice!), I was thinking that it might be useful for users to provide
the link to these manual pages. This might be useful for users browsing the
available addons on that wiki page.

I don't mind doing that (for GRASS 7) if others think that it is a good
idea. If so, is there a similar shortcut as for the source files, e.g.,:
{{AddonManual|raster|addon_name|version=7}}

The situation now is unclear. There is the list on the wiki but also the
generated list at http://grass.osgeo.org/grass70/manuals/addons/

That is true

What about something like wiki just linking this list plus having list of
addons which are not in the official repository?

Although nice to have this automatically generated list, I need to click
on each one to get a first impression what it is for (it is not always
possible to guess this from the name). I like the wiki page in that it
provide a very brief description / impression what the addons are about at
a glance.

This will not be solved by wiki page because this has to be manually

updated. This should be done by the script which generates the page. Addons
page should be similar to
http://grass.osgeo.org/grass71/manuals/full_index.html

Paulo

_______________________________________________
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

5

On Sun, Jan 25, 2015 at 2:20 AM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

On Sat, Jan 24, 2015 at 6:33 PM, Paulo van Breugel <p.vanbreugel@gmail.com
> wrote:

On Sun, Jan 25, 2015 at 12:25 AM, Vaclav Petras <wenzeslaus@gmail.com>
wrote:

On Sat, Jan 24, 2015 at 6:17 PM, Paulo van Breugel <
p.vanbreugel@gmail.com> wrote:

Currently on the http://grasswiki.osgeo.org/wiki/AddOns/GRASS7/ page
the link to the source files are provided (for those uploaded to the grass
gis addon svn).

Now that online manual pages of the addons are automatically created
(very nice!), I was thinking that it might be useful for users to provide
the link to these manual pages. This might be useful for users browsing the
available addons on that wiki page.

I don't mind doing that (for GRASS 7) if others think that it is a good
idea. If so, is there a similar shortcut as for the source files, e.g.,:
{{AddonManual|raster|addon_name|version=7}}

The situation now is unclear. There is the list on the wiki but also the
generated list at http://grass.osgeo.org/grass70/manuals/addons/

That is true

What about something like wiki just linking this list plus having list
of addons which are not in the official repository?

Although nice to have this automatically generated list, I need to click
on each one to get a first impression what it is for (it is not always
possible to guess this from the name). I like the wiki page in that it
provide a very brief description / impression what the addons are about at
a glance.

This will not be solved by wiki page because this has to be manually

updated.

The wiki page does provide a line or two explanation for most addons, so in
that sense it does provide an solution

This should be done by the script which generates the page. Addons page
should be similar to
http://grass.osgeo.org/grass71/manuals/full_index.html

But if it could be generated automatically in something similar to your
example, that would be awesome! Any plans for that?

Paulo

_______________________________________________
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

6

On Sun, Jan 25, 2015 at 2:20 AM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

On Sat, Jan 24, 2015 at 6:33 PM, Paulo van Breugel <p.vanbreugel@gmail.com>
wrote:

Although nice to have this automatically generated list, I need to click
on each one to get a first impression what it is for (it is not always
possible to guess this from the name).

This will not be solved by wiki page because this has to be manually
updated. This should be done by the script which generates the page.

I have updated that script now. Voilà:

http://grass.osgeo.org/grass70/manuals/addons/

Cheers
Markus

7

On Sun, Jan 25, 2015 at 1:09 PM, Markus Neteler <neteler@osgeo.org> wrote:

On Sun, Jan 25, 2015 at 2:20 AM, Vaclav Petras <wenzeslaus@gmail.com>
wrote:
> On Sat, Jan 24, 2015 at 6:33 PM, Paulo van Breugel <
p.vanbreugel@gmail.com>
> wrote:
>> Although nice to have this automatically generated list, I need to click
>> on each one to get a first impression what it is for (it is not always
>> possible to guess this from the name).
>
> This will not be solved by wiki page because this has to be manually
> updated. This should be done by the script which generates the page.

I have updated that script now. Voilà:

http://grass.osgeo.org/grass70/manuals/addons/

Woh, brilliant!

Given this is done, I think the suggestion of Vaclav is something to
consider.. to adapt the wiki page, placing a link to this page + list of
addons not in the official repository? Or anything that provides a more
unified overview of what is available?

Cheers
Markus

8

On Sun, Jan 25, 2015 at 3:13 PM, Paulo van Breugel <p.vanbreugel@gmail.com>
wrote:

On Sun, Jan 25, 2015 at 1:09 PM, Markus Neteler <neteler@osgeo.org> wrote:

On Sun, Jan 25, 2015 at 2:20 AM, Vaclav Petras <wenzeslaus@gmail.com>
wrote:
> On Sat, Jan 24, 2015 at 6:33 PM, Paulo van Breugel <
p.vanbreugel@gmail.com>
> wrote:
>> Although nice to have this automatically generated list, I need to
click
>> on each one to get a first impression what it is for (it is not always
>> possible to guess this from the name).
>
> This will not be solved by wiki page because this has to be manually
> updated. This should be done by the script which generates the page.

I have updated that script now. Voilà:

http://grass.osgeo.org/grass70/manuals/addons/

One very minor suggestion, for readability of the list, perhaps a slightly
larger line distance would be better?

Woh, brilliant!

Given this is done, I think the suggestion of Vaclav is something to
consider.. to adapt the wiki page, placing a link to this page + list of
addons not in the official repository? Or anything that provides a more
unified overview of what is available?

Cheers
Markus

9

On Sun, Jan 25, 2015 at 5:05 PM, Paulo van Breugel
<p.vanbreugel@gmail.com> wrote:

On Sun, Jan 25, 2015 at 3:13 PM, Paulo van Breugel <p.vanbreugel@gmail.com>

On Sun, Jan 25, 2015 at 1:09 PM, Markus Neteler <neteler@osgeo.org> wrote:

I have updated that script now. Voilà:

http://grass.osgeo.org/grass70/manuals/addons/

One very minor suggestion, for readability of the list, perhaps a slightly
larger line distance would be better?

Agreed but it should already be like this since the standard CSS is used.
Not sure if we need the <div> magic also here.

Woh, brilliant!

Given this is done, I think the suggestion of Vaclav is something to
consider.. to adapt the wiki page, placing a link to this page + list of
addons not in the official repository? Or anything that provides a more
unified overview of what is available?

Yes - feel free to tune the Wiki.

Markus

10

On 25/01/15 13:09, Markus Neteler wrote:

On Sun, Jan 25, 2015 at 2:20 AM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

On Sat, Jan 24, 2015 at 6:33 PM, Paulo van Breugel <p.vanbreugel@gmail.com>
wrote:

Although nice to have this automatically generated list, I need to click
on each one to get a first impression what it is for (it is not always
possible to guess this from the name).

This will not be solved by wiki page because this has to be manually
updated. This should be done by the script which generates the page.

I have updated that script now. Voilà:

http://grass.osgeo.org/grass70/manuals/addons/

Great !

Just one issue: some of the add-ons fail to compile on the server, sometimes because some additional libraries are missing (ex: v.class.mlpy, v.nnstat and v.kriging) and because of that they are not listed on this page.

I don't know what the policy is: should all modules compile on the server and so should all dependencies be installed, or do we have to find a different solution for these ? Is it possible to only make the man pages and so avoid the issue of dependencies in the main source code ?

Moritz

11

On Tue, Jan 27, 2015 at 10:17 AM, Moritz Lennert
<mlennert@club.worldonline.be> wrote:

On 25/01/15 13:09, Markus Neteler wrote:

I have updated that script now. Voilà:

http://grass.osgeo.org/grass70/manuals/addons/

Great !

Just one issue: some of the add-ons fail to compile on the server, sometimes
because some additional libraries are missing (ex: v.class.mlpy, v.nnstat
and v.kriging)

Yes, because they are compiled on the Windows server which generates
the nightly snapshots which does not have all packages.

and because of that they are not listed on this page.

Do you have an example? They are all autogenerated if they are in the
parent Makefile registered.

I don't know what the policy is: should all modules compile on the server
and so should all dependencies be installed,

Ideally yes but that's quite some work for the Windows server admin...

or do we have to find a
different solution for these ? Is it possible to only make the man pages and
so avoid the issue of dependencies in the main source code ?

I could instead generate them on Linux. But not too soon due to being
too busy these days.

Markus

12

2015-02-04 22:51 GMT+01:00 Markus Neteler <neteler@osgeo.org>:

I could instead generate them on Linux. But not too soon due to being
too busy these days.

btw, then manual pages [1] are not generated on Windows but on Linux [2].

Martin

[1] http://grass.osgeo.org/grass70/manuals/addons/
[2] http://grass.osgeo.org/addons/grass7/logs/summary.html

--
Martin Landa
http://geo.fsv.cvut.cz/gwiki/Landa
http://gismentors.eu/mentors/landa

13

On Wed, Feb 4, 2015 at 10:56 PM, Martin Landa <landa.martin@gmail.com> wrote:

2015-02-04 22:51 GMT+01:00 Markus Neteler <neteler@osgeo.org>:

I could instead generate them on Linux. But not too soon due to being
too busy these days.

btw, then manual pages [1] are not generated on Windows but on Linux [2].

Martin

[1] http://grass.osgeo.org/grass70/manuals/addons/
[2] http://grass.osgeo.org/addons/grass7/logs/summary.html

ah, ok. So now I checked all failing modules:
- PCL libs to be installed: impossible on Debian 6
- f77: gfortran does not seem to contain it
- i.spec.* require LAPACK/BLAS which would enlarge the weekly snapshot
- one module is a shell script and needs to be rewritten to Python
- something else which I cannot immediately solve

Markus

14

On Wed, Feb 4, 2015 at 4:51 PM, Markus Neteler <neteler@osgeo.org> wrote:

On Tue, Jan 27, 2015 at 10:17 AM, Moritz Lennert
<mlennert@club.worldonline.be> wrote:
> On 25/01/15 13:09, Markus Neteler wrote:
>> I have updated that script now. Voilà:
>>
>> http://grass.osgeo.org/grass70/manuals/addons/
>
>
> Great !
>
> Just one issue: some of the add-ons fail to compile on the server,
sometimes
> because some additional libraries are missing (ex: v.class.mlpy, v.nnstat
> and v.kriging)

Yes, because they are compiled on the Windows server which generates
the nightly snapshots which does not have all packages.

Dependencies are easier to solve on Linux than on MS Windows but sometimes
it just might be too complicated to get them.

With Andy [1] we tried yesterday an approach where you avoid import of the
uncommon dependency at the beginning [2] and you import it only after
grass.script.parser() call [3]. This approach seems to work sufficiently
[4]. If the dependency is not present, user will get an after running the
module, GUI and help will be shown, which might be actually a bit
frustrating because at this point you already filled all the parameters,
however, it seems like a good compromise. It should work for most of the
Python scripts, e.g. v.class.mlpy and v.class.ml.

Another thing which needs more work is a possibility of installing
dependencies using the module itself, e.g. when a special flag (possibly
not processes by parser) is provided.

See also "how to formulate Makefiles for addons so that additional files
get installed correctly by g.extension" discussion [1].

Vaclav

[1] http://lists.osgeo.org/pipermail/grass-dev/2015-February/073713.html
[2]
http://trac.osgeo.org/grass/browser/grass-addons/grass7/raster/r.flexure/r.flexure.py?rev=64452#L157
[3]
http://trac.osgeo.org/grass/browser/grass-addons/grass7/raster/r.flexure/r.flexure.py?rev=64452#L176
[4] http://grass.osgeo.org/grass70/manuals/addons/r.flexure.html
[5]
http://trac.osgeo.org/grass/browser/grass-addons/grass7/raster/r.flexure/r.flexure.py?rev=64452#L295

> and because of that they are not listed on this page.

Do you have an example? They are all autogenerated if they are in the
parent Makefile registered.

> I don't know what the policy is: should all modules compile on the server
> and so should all dependencies be installed,

Ideally yes but that's quite some work for the Windows server admin...

> or do we have to find a
> different solution for these ? Is it possible to only make the man pages
and
> so avoid the issue of dependencies in the main source code ?

I could instead generate them on Linux. But not too soon due to being
too busy these days.

Markus

15

On 04/02/15 23:21, Vaclav Petras wrote:

See also "how to formulate Makefiles for addons so that additional files
get installed correctly by g.extension" discussion [1].

Vaclav

[1] http://lists.osgeo.org/pipermail/grass-dev/2015-February/073713.html

Well, this thread is not so much about external dependencies, but more about the fact that a series of addon modules that split their code into several python files do not get these installed correctly when installing via g.extension, whereas they do when you compile directly from the source tree via 'make MODULE_TOPDIR='.

Examples are #2480 (v.class.ml) and #2534 (i.segment.hierarchical). Pietro do you have any ideas for these ?

Moritz

16

Hi,

2015-02-05 8:36 GMT+01:00 Moritz Lennert <mlennert@club.worldonline.be>:

Well, this thread is not so much about external dependencies, but more about
the fact that a series of addon modules that split their code into several
python files do not get these installed correctly when installing via
g.extension, whereas they do when you compile directly from the source tree
via 'make MODULE_TOPDIR='.

ETCFILES should work (it's installed to GRASS_ADDON_BASE/etc/module). Martin

--
Martin Landa
http://geo.fsv.cvut.cz/gwiki/Landa
http://gismentors.eu/mentors/landa