Difference between revisions of "Software entry example"

From ESL
Jump to navigation Jump to search
(Introduce words into template)
Line 1: Line 1:
Some introductory words
+
The entry is first introduced with a few lines of what the software is about.
 +
An introductory abstract. Brief but sufficient to transmit the reader what he/she
 +
needs to know in order to decide whether it is interesting for his/her project.
 +
 
 +
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse tempor dolor
 +
vel placerat iaculis. Sed consectetur elit eu accumsan dapibus. Quisque sed dolor
 +
eu lacus laoreet vehicula. Etiam sed urna nec sem mollis fringilla. Ut at suscipit neque.
 +
Phasellus sed diam at arcu tincidunt fringilla. Etiam volutpat ligula eu sollicitudin pulvinar.
 +
Suspendisse potenti. Suspendisse gravida interdum tellus non iaculis. Nulla vitae libero turpis. Nam venenatis enim quis est rutrum, et molestie lorem egestas. Integer purus lorem, vulputate eget tincidunt quis, suscipit sed nunc. Phasellus volutpat sem ut luctus tristique. Donec nulla nisi, vehicula sit amet adipiscing eget, convallis quis eros. Ut viverra egestas metus dictum auctor. Sed tortor lacus, malesuada non lectus a, facilisis feugiat nisl. Cras commodo sed enim ac euismod. Curabitur justo metus, lobortis in adipiscing vitae, elementum vel ipsum. Vestibulum dapibus in massa at pellentesque. Mauris a velit felis.
  
 
== Theory  ==
 
== Theory  ==
(optional)  
+
''(Optional)'' Here the basic theory behind the software is described, including the
 +
algorithm specification and brief description. Depending on the kind of entry this section
 +
can vary in length and even be absent if the function of the software is standard or
 +
obvious from the initial description above. It allows for equations as interesting as this one
 +
: <math> H | \Psi \rangle = E | \Psi \rangle </math>,
 +
but, of course, not forgetting that <math> E = mc^2 </math>, that is, allowing for isolated
 +
and indented, or in-line equations. If you view the source or edit it, you will see how easy
 +
it is, just using LaTeX.
 +
Maecenas ut porttitor purus. Fusce laoreet tortor at urna consectetur, eget posuere sapien pharetra. Etiam lorem turpis, consequat nec nisi aliquam, facilisis porttitor nisi. Ut eget lorem non sem suscipit condimentum sed id nisi. Vivamus sed dignissim odio. Pellentesque auctor metus erat, at vestibulum enim viverra non. Aenean nec tempor massa, ut feugiat ipsum.
  
 +
 
== Authors ==
 
== Authors ==
(mandatory)
+
''(Mandatory)''
  
 
'''Library/Module/Subroutine authors'''
 
'''Library/Module/Subroutine authors'''
Line 14: Line 31:
  
 
== Publications ==  
 
== Publications ==  
(mandatory)
+
''(Mandatory)''
  
 
(example:)<br />
 
(example:)<br />
Line 20: Line 37:
  
 
== Download ==
 
== Download ==
(mandatory)
+
''(Mandatory)''
  
 
== Installation ==  
 
== Installation ==  
(mandatory)
+
''(Mandatory)''
 +
 
 
=== Prerequisites ===
 
=== Prerequisites ===
 
=== Instructions ===
 
=== Instructions ===
Line 29: Line 47:
  
 
== Programming Interface ==  
 
== Programming Interface ==  
(mandatory, in some cases can link to external page or to other wiki-page)
+
''(Mandatory)'' in some cases can link to external page or to other wiki-page)
  
 
<code>subroutine theRoutine( a, B, result, n, w)</code>
 
<code>subroutine theRoutine( a, B, result, n, w)</code>

Revision as of 17:20, 4 July 2014

The entry is first introduced with a few lines of what the software is about. An introductory abstract. Brief but sufficient to transmit the reader what he/she needs to know in order to decide whether it is interesting for his/her project.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse tempor dolor vel placerat iaculis. Sed consectetur elit eu accumsan dapibus. Quisque sed dolor eu lacus laoreet vehicula. Etiam sed urna nec sem mollis fringilla. Ut at suscipit neque. Phasellus sed diam at arcu tincidunt fringilla. Etiam volutpat ligula eu sollicitudin pulvinar. Suspendisse potenti. Suspendisse gravida interdum tellus non iaculis. Nulla vitae libero turpis. Nam venenatis enim quis est rutrum, et molestie lorem egestas. Integer purus lorem, vulputate eget tincidunt quis, suscipit sed nunc. Phasellus volutpat sem ut luctus tristique. Donec nulla nisi, vehicula sit amet adipiscing eget, convallis quis eros. Ut viverra egestas metus dictum auctor. Sed tortor lacus, malesuada non lectus a, facilisis feugiat nisl. Cras commodo sed enim ac euismod. Curabitur justo metus, lobortis in adipiscing vitae, elementum vel ipsum. Vestibulum dapibus in massa at pellentesque. Mauris a velit felis.

Theory

(Optional) Here the basic theory behind the software is described, including the algorithm specification and brief description. Depending on the kind of entry this section can vary in length and even be absent if the function of the software is standard or obvious from the initial description above. It allows for equations as interesting as this one

,

but, of course, not forgetting that , that is, allowing for isolated and indented, or in-line equations. If you view the source or edit it, you will see how easy it is, just using LaTeX. Maecenas ut porttitor purus. Fusce laoreet tortor at urna consectetur, eget posuere sapien pharetra. Etiam lorem turpis, consequat nec nisi aliquam, facilisis porttitor nisi. Ut eget lorem non sem suscipit condimentum sed id nisi. Vivamus sed dignissim odio. Pellentesque auctor metus erat, at vestibulum enim viverra non. Aenean nec tempor massa, ut feugiat ipsum.


Authors

(Mandatory)

Library/Module/Subroutine authors

  • Name, Institution, Homepage (suggested format)

Responsible for ESL entry

Publications

(Mandatory)

(example:)
The main paper is [1]

Download

(Mandatory)

Installation

(Mandatory)

Prerequisites

Instructions

Tests

Programming Interface

(Mandatory) in some cases can link to external page or to other wiki-page)

subroutine theRoutine( a, B, result, n, w)

Solver specific:

  • a (input) INTEGER
    Variable a
  • B (input) DOUBLE PRECISION array, dimension (a,a)
    Matrix B.
  • result (output) DOUBLE PRECISION array, dimension (a,a)
    The result.

Algorithm specific:

  • n (output) DOUBLE PRECISION
    Variable n.

Implementation specific:

  • w (input, optional) LOGICAL
    T: Do this.
    F: Don't do it.


Other sections

(space for library-specific sections, optional)

References

(optional)

  1. Authors, Title, ... Link