Difference between revisions of "Template:Infobox Software"

From HPC Wiki
Jump to navigation Jump to search
m (Fix alignment of name)
m (Tweak display of homepage and email)
Line 57: Line 57:
 
| provider = Maker of the Software
 
| provider = Maker of the Software
 
| logo = [https://institute.org/ Some Tool]
 
| logo = [https://institute.org/ Some Tool]
| homepage = [https://institute.org/ Some Tool]
+
| homepage = https://institute.org/
 +
| email = support@provider.org
 
| concurrency = parallel
 
| concurrency = parallel
 
| pmodel = MPI, OpenMP, Pthreads
 
| pmodel = MPI, OpenMP, Pthreads
Line 83: Line 84:
 
{{!}}-  
 
{{!}}-  
 
{{!}} style="text-align:left; font-weight: bold;" {{!}} Homepage:
 
{{!}} style="text-align:left; font-weight: bold;" {{!}} Homepage:
{{!}} style="text-align:right" {{!}} {{{homepage}}}
+
{{!}} style="text-align:right" {{!}} [{{{homepage}}} {{{homepage}}}]
 
}}
 
}}
 
{{#if: {{{email|}}} |
 
{{#if: {{{email|}}} |
 
{{!}}-  
 
{{!}}-  
 
{{!}} style="text-align:left; font-weight: bold;" {{!}} E-Mail:
 
{{!}} style="text-align:left; font-weight: bold;" {{!}} E-Mail:
{{!}} style="text-align:right" {{!}} [mailto:{{{email}}}]
+
{{!}} style="text-align:right" {{!}} [mailto:{{{email}}} {{{email}}}]
 
}}
 
}}
 
{{#if: {{{concurrency|}}} |
 
{{#if: {{{concurrency|}}} |

Revision as of 15:07, 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: https://institute.org/
E-Mail: support@provider.org
Concurrency: parallel
Programming Model: MPI, OpenMP, Pthreads
Programming Language: C, C++, Fortran