Re: [easybuild] What can be added to the module information
Thanks a lot! El jue., 14 may. 2020 a las 8:13, Markus Geimer () escribió: > Arnau, > > On 5/13/20 4:45 PM, Arnau wrote: > > What information from the easyconfig can/will be added to the "More > > information" part of the generated module file? > > This section will include information from the following easyconfig > parameters: > > - homepage > - docpaths > - docurls > - site_contacts > - upstream_contacts > > > can the whole Help section be (easily) customized? > > There are also the parameters > > - description > - usage > - examples > > which generate additional sections. See [1] for details on how the > modulefile is generated and what ends up in which section. > > Hth, > Markus > > > [1] > > https://github.com/easybuilders/easybuild-framework/blob/develop/easybuild/tools/module_generator.py#L548 > > > -- > Dr. Markus Geimer > Juelich Supercomputing Centre > Institute for Advanced Simulation > Forschungszentrum Juelich GmbH > 52425 Juelich, Germany > > Phone: +49-2461-61-1773 > Fax: +49-2461-61-6656 > Email: m.gei...@fz-juelich.de > WWW: https://www.fz-juelich.de/ias/jsc > > > > > > > Forschungszentrum Juelich GmbH > 52425 Juelich > Sitz der Gesellschaft: Juelich > Eingetragen im Handelsregister des Amtsgerichts Dueren Nr. HR B 3498 > Vorsitzender des Aufsichtsrats: MinDir Volker Rieke > Geschaeftsfuehrung: Prof. Dr.-Ing. Wolfgang Marquardt (Vorsitzender), > Karsten Beneke (stellv. Vorsitzender), Prof. Dr.-Ing. Harald Bolt > > > > > >
Re: [easybuild] What can be added to the module information
Markus Geimer writes:
> Arnau,
>
> On 5/13/20 4:45 PM, Arnau wrote:
>> What information from the easyconfig can/will be added to the "More
>> information" part of the generated module file?
>
> This section will include information from the following easyconfig
> parameters:
>
> - homepage
> - docpaths
> - docurls
> - site_contacts
> - upstream_contacts
>
>> can the whole Help section be (easily) customized?
>
> There are also the parameters
>
> - description
> - usage
> - examples
>
> which generate additional sections. See [1] for details on how the
> modulefile is generated and what ends up in which section.
If you want to add help to existing EasyConfigs, then you can probably
do this via hooks
https://easybuild.readthedocs.io/en/latest/Hooks.html
This is something I have been meaning to do, but haven't got round to
it.
Having said that, I feel that there could be more information on usage
provided by the EasyConfigs distributed with EasyBuild. For example, as
far as I am aware the program ORCA must be called via an absolute path,
otherwise various subprogramms (all separate binaries) won't be found.
Thus we have to tell all our ORCA users to run the program with
${EBROOTORCA}/orca
even though 'orca' will be found via the PATH variable. This is
something I would add to a documentation hook, but shouldn't it really
go in the main EC if it applies to everyone?
Sorry for hijacking the thread
Loris
> Hth,
> Markus
>
>
> [1]
> https://github.com/easybuilders/easybuild-framework/blob/develop/easybuild/tools/module_generator.py#L548
>
>
> --
> Dr. Markus Geimer
> Juelich Supercomputing Centre
> Institute for Advanced Simulation
> Forschungszentrum Juelich GmbH
> 52425 Juelich, Germany
>
> Phone: +49-2461-61-1773
> Fax: +49-2461-61-6656
> Email: m.gei...@fz-juelich.de
> WWW: https://www.fz-juelich.de/ias/jsc
>
>
>
>
> Forschungszentrum Juelich GmbH
> 52425 Juelich
> Sitz der Gesellschaft: Juelich
> Eingetragen im Handelsregister des Amtsgerichts Dueren Nr. HR B 3498
> Vorsitzender des Aufsichtsrats: MinDir Volker Rieke
> Geschaeftsfuehrung: Prof. Dr.-Ing. Wolfgang Marquardt (Vorsitzender),
> Karsten Beneke (stellv. Vorsitzender), Prof. Dr.-Ing. Harald Bolt
>
>
Re: [easybuild] What can be added to the module information
Arnau, On 5/13/20 4:45 PM, Arnau wrote: What information from the easyconfig can/will be added to the "More information" part of the generated module file? This section will include information from the following easyconfig parameters: - homepage - docpaths - docurls - site_contacts - upstream_contacts can the whole Help section be (easily) customized? There are also the parameters - description - usage - examples which generate additional sections. See [1] for details on how the modulefile is generated and what ends up in which section. Hth, Markus [1] https://github.com/easybuilders/easybuild-framework/blob/develop/easybuild/tools/module_generator.py#L548 -- Dr. Markus Geimer Juelich Supercomputing Centre Institute for Advanced Simulation Forschungszentrum Juelich GmbH 52425 Juelich, Germany Phone: +49-2461-61-1773 Fax: +49-2461-61-6656 Email: m.gei...@fz-juelich.de WWW: https://www.fz-juelich.de/ias/jsc Forschungszentrum Juelich GmbH 52425 Juelich Sitz der Gesellschaft: Juelich Eingetragen im Handelsregister des Amtsgerichts Dueren Nr. HR B 3498 Vorsitzender des Aufsichtsrats: MinDir Volker Rieke Geschaeftsfuehrung: Prof. Dr.-Ing. Wolfgang Marquardt (Vorsitzender), Karsten Beneke (stellv. Vorsitzender), Prof. Dr.-Ing. Harald Bolt
Re: [easybuild] What can be added to the module information
Arnau writes: > What information from the easyconfig can/will be added to the "More > information" part of the generated module file? > > can the whole Help section be (easily) customized? > > > Description: > > Automake: GNU Standards-compliant Makefile generator > > This module can be loaded directly: module load Automake/1.15 > > Help: > > > > * Description === Automake: GNU Standards-compliant > > Makefile generator More information - > > Homepage: http://www.gnu.org/software/automake/automake.html The "description" in the EasyConfig (.eb) file can be an arbitrary multiline string, with as much detail as you like. Here's the description from the "rootpy" module, for example: description = """The rootpy project is a community-driven initiative aiming to provide a more pythonic interface with ROOT on top of the existing PyROOT bindings. Given Python's reflective and dynamic nature, rootpy also aims to improve ROOT design flaws and supplement existing ROOT functionality. The scientific Python community also offers a multitude of powerful packages such as SciPy, NumPy, matplotlib, scikit-learn, and PyTables, but a suitable interface between them and ROOT has been lacking. rootpy provides the interfaces and conversion mechanisms required to liberate your data and to take advantage of these alternatives if needed.""" The "homepage" string is supposed to just be a URL, but I suppose it could be a list of URLs (I don't know whether there's an |eb| mode or Web interfaces that turn them into active hyperlinks). -- Mike Kelsey
