Difference between revisions of "Template:Infobox Software"

From HPC Wiki
Jump to navigation Jump to search
(Initial draft)
 
m (Use propper approach to avoid linebreaks if parameter is missing)
 
(7 intermediate revisions by the same user not shown)
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
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 64: Line 65:
 
}}
 
}}
 
</noinclude>
 
</noinclude>
−
<includeonly>{| align="right" cellpadding="5" border="0" style="border-spacing: 0px; background-color: #fbfbff; font-size: 95%; margin: 0 0 0.5em 1em; width: 25em; border: 1pt; {{#ifeq:{{NAMESPACE}}|Template||float: right;}}"
+
<includeonly>{| align="right" cellpadding="5" style="border-spacing: 0px; background-color: #fbfbff; font-size: 95%; margin: 0 0 0.5em 1em; width: 25em; border: 1px solid #dddddd; {{#ifeq:{{NAMESPACE}}|Template||float: right;}}"
 
|-
 
|-
 
  ! colspan="2" style="background-color:#2e3871; color:white" | Software
 
  ! colspan="2" style="background-color:#2e3871; color:white" | Software
 
|-  
 
|-  
 
| style="font-weight: bold;" | Name:
 
| style="font-weight: bold;" | Name:
−
| {{#if: {{{name|}}} | {{{Name}}} | Unknown }}  
+
| style="text-align:right" | {{#if: {{{name|}}} | {{{name}}} | Unknown }}  
−
{{#if: {{{provider|}}} |
+
{{#if: {{{provider|}}} | <nowiki />
−
{{!}}-  
+
  {{!}}-  
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} Provider:
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} Provider:
−
{{!}} style="text-align:right" {{!}} {{{provider}}}
+
  {{!}} style="text-align:right" {{!}} {{{provider}}}
−
}}
+
}}{{#if: {{{license|}}} | <nowiki />
−
{{#if: {{{license|}}} |
+
  {{!}}-  
−
{{!}}-  
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} License:
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} License:
+
  {{!}} style="text-align:right" {{!}} {{{license}}}
−
{{!}} style="text-align:right" {{!}} {{{license}}}
+
}}{{#if: {{{homepage|}}} | <nowiki />
−
}}
+
  {{!}}-  
−
{{#if: {{{homepage|}}} |
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} Homepage:
−
{{!}}-  
+
  {{!}} style="text-align:right" {{!}} [{{{homepage}}} {{{homepage}}}]
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} Homepage:
+
}}{{#if: {{{email|}}} | <nowiki />
−
{{!}} style="text-align:right" {{!}} {{{homepage}}}
+
  {{!}}-  
−
}}
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} E-Mail:
−
{{#if: {{{email|}}} |
+
  {{!}} style="text-align:right" {{!}} [mailto:{{{email}}} {{{email}}}]
−
{{!}}-  
+
}}{{#if: {{{concurrency|}}} | <nowiki />
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} E-Mail:
+
  {{!}}-  
−
{{!}} style="text-align:right" {{!}} {{{email}}}
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} Concurrency:
−
}}
+
  {{!}} style="text-align:right" {{!}} {{{concurrency}}}
−
{{#if: {{{concurrency|}}} |
+
}}{{#if: {{{focus|}}} | <nowiki />
−
{{!}}-  
+
  {{!}}-  
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} Concurrency:
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} Focus:
−
{{!}} style="text-align:right" {{!}} {{{concurrency}}}
+
  {{!}} style="text-align:right" {{!}} {{{focus}}}
−
}}
+
}}{{#if: {{{pmodel|}}} | <nowiki />
−
{{#if: {{{focus|}}} |
+
  {{!}}-  
−
{{!}}-  
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} Programming Model:
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} Focus:
+
  {{!}} style="text-align:right" {{!}} {{{pmodel}}}
−
{{!}} style="text-align:right" {{!}} {{{focus}}}
+
}}{{#if: {{{lang|}}} | <nowiki />
−
}}
+
  {{!}}-  
−
{{#if: {{{pmodel|}}} |
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} Programming Language:
−
{{!}}-  
+
  {{!}} style="text-align:right" {{!}} {{{lang}}}
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} Programming Model:
+
}}{{#if: {{{arch|}}} | <nowiki />
−
{{!}} style="text-align:right" {{!}} {{{pmodel}}}
+
  {{!}}-  
−
}}
+
  {{!}} style="text-align:left; font-weight: bold;" {{!}} Architecture:
−
{{#if: {{{lang|}}} |
+
  {{!}} style="text-align:right" {{!}} {{{arch}}}
−
{{!}}-  
 
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} Programming Language:
 
−
{{!}} style="text-align:right" {{!}} {{{lang}}}
 
−
}}
 
−
{{#if: {{{arch|}}} |
 
−
{{!}}-  
 
−
{{!}} style="text-align:left; font-weight: bold;" {{!}} Architecture:
 
−
{{!}} style="text-align:right" {{!}} {{{arch}}}
 
 
}}
 
}}
 +
|}
 
</includeonly>
 
</includeonly>

Latest revision as of 12:30, 19 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


Retrieved from "https://hpc-wiki.info/hpc/index.php?title=Template:Infobox_Software&oldid=4181"