Difference between revisions of "Template:Infobox Software"

From HPC Wiki
Jump to navigation Jump to search
m (Fix typo)
m (Improve documentation)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 
This template can be used to typeset an infobox on the top right corner on software product pages.
 
This template can be used to typeset an infobox on the top right corner on software product pages.
 +
 +
<nowiki>
 +
{{Infobox Software
 +
| name = Name of the Software
 +
| provider = Maker of the Software
 +
| logo = [https://institute.org/ Some Tool]
 +
| homepage = [https://institute.org/ Some Tool]
 +
| email = contact@provider.org
 +
| concurrency = parallel
 +
| pmodel = MPI, OpenMP, Pthreads
 +
| lang = C, C++, Fortran
 +
| license = {{License_GPLv3}}
 +
}}</nowiki>
  
 
The info fields for the software largely cover the classification done by the [https://www.vi-hps.org/cms/upload/material/general/ToolsGuide.pdf VI-HPS Tools Guide]
 
The info fields for the software largely cover the classification done by the [https://www.vi-hps.org/cms/upload/material/general/ToolsGuide.pdf VI-HPS Tools Guide]
Line 39: Line 52:
 
** ARM
 
** ARM
 
** GPU
 
** GPU
 
<nowiki>
 
{{Infobox Software
 
| name = Name of the Software
 
| provider = Maker of the Software
 
| logo = [https://institute.org/ Some Tool]
 
| homepage = [https://institute.org/ Some Tool]
 
| email = contact@provider.org
 
| concurrency = parallel
 
| pmodel = MPI, OpenMP, Pthreads
 
| lang = C, C++, Fortran
 
| license = {{License_GPLv3}}
 
}}</nowiki>
 
  
 
{{Infobox Software
 
{{Infobox Software

Revision as of 14:56, 18 November 2020

This template can be used to typeset an infobox on the top right corner on software product pages.

 {{Infobox Software
 | name = Name of the Software
 | provider = Maker of the Software
 | logo = [https://institute.org/ Some Tool]
 | homepage = [https://institute.org/ Some Tool]
 | email = contact@provider.org
 | concurrency = parallel
 | pmodel = MPI, OpenMP, Pthreads
 | lang = C, C++, Fortran
 | license = {{License_GPLv3}}
 }}

The info fields for the software largely cover the classification done by the VI-HPS Tools Guide To maintain consistency across the software packages presented, the following options should be used for the individual info fields.

  • Concurrency:
    • Single
    • Parallel
  • Focus:
    • Performance
    • Debugging
    • Correctness
    • Workflow
  • Programming Model (pmodel):
    • MPI
    • OpenMP
    • PThreads
    • OmpSs
    • OpenCL
    • OpenACC
    • CUDA
    • SYCL
    • UPC
    • SHMEM
  • Programming Lanugages (lang):
    • C
    • C++
    • Fortran
    • Python
    • Agnostic (if the programming language does not really matter)
  • Architecture (arch):
    • x86
    • Power
    • ARM
    • GPU


Software
Name: Name of the Software
Provider: Maker of the Software
License: GPL Version 3
Homepage: Some Tool
Concurrency: parallel
Programming Model: MPI, OpenMP, Pthreads
Programming Language: C, C++, Fortran