Difference between revisions of "Software entry example"

From ESL
Jump to navigation Jump to search
(Restructured, using a box for selected entries)
Line 1: Line 1:
  
 
{{techbox |  
 
{{techbox |  
authors = Name, Institution, [http://goesnowhere.com/ Homepage] (suggested format) |
+
authors = Name, Institution, [http://goesnowhere.com/ Homepage] (suggested format), Name2, Institution2, [http://goesnowhere.com/ Homepage] |
 
esl-entry = [[User:A-N.Other|A.N. Other]] (wiki-profile) |
 
esl-entry = [[User:A-N.Other|A.N. Other]] (wiki-profile) |
 
license = This software is licensed under LGPL |
 
license = This software is licensed under LGPL |

Revision as of 11:42, 10 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.


Publications

(Mandatory) The main paper describing this piece of software is [1]


Installation

(Mandatory)

Prerequisites

List here dependencies

Instructions

On how to install, link etc.

Tests

Here you provide information on tests prepared for the software.

Programming Interface

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

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

Implementation independent:

  • 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.

Future developments

(Optional) You can announce here things to come related to your software, keeping in mind that you want to deliver.

Other sections

(Optional) Other sections can be added if relevant for the software.

References

(Optional)

  1. Authors, Title, ... Link