Software Requirements Specification

Release Information

Project: Siconos
Internal Release Number: 1.0
Last update: September 15, 2005
Attached worksheets:
Related Documents:
  • "Guide to software requirements specifications", standard 830 - 1984,IEEE.
  • Draft version of SRD of SICONOS / WP2, January 2004.
  • Templates and Guides, Roger Pissard-Gibollet, INRIA
  • SICONOS Contract Number IST-2001-37172 and annexes
  • SICONOS web site : http://siconos.inrialpes.fr

Introduction

For the first version of the Siconos software, most of the users are scientists from various scientific fields : mathematicians, physicists, electrical and mechanical engineers, etc... Their computer skills are heterogeneous, but they have basic knowledges in computer science. Most of them already use scientific softwares like Matlab, Scilab or dedicated softwares for their own scientific fields (e.g. Lmgc90). Nevertheless, the platform have to be developed with well-known coding languages and interfaces.

One of the most important requirements in the distribution of the software is that it will be Open Source (see the definition at http://www.opensource.org/docs/definition.php). One goal is to bring together a wide community of scientists to use and to develop several new numerical methods. Therefore, standards development tools must be used.

Finally, for the users which come from the industry or the private company, the software must be compatible with standard softwares of scientific computing already used in the industry.

Use Cases

The use case suite lists all use cases in an organized way. Actors are described. 

Functional Requirements

The feature set lists all features in an organized way.

Non-Functional Requirements

What are the performance requirements?

  • PER-00 : The software must not be more than 10% slower than Lmgc90 for the same treatment on the same computer

What are the documentation requirements?

The documentation must contain :

  • DOC-1.00 : a Software User Manual (SUM)
  • DOC-1.01 : a Getting Started document
  • DOC-1.02 : an Example problems Manual
  • DOC-1.03 : a Theory Manual
  • DOC-1.04 : a Developer Manual

The Documentation format requirements are:

  • DOC-2.00 : The source of User and Theory manuals must be in TeX format.
  • DOC-2.01 : Other manuals must be available in HTML format.
  • DOC-2.02 : All manuals must be available in PDF format.
  • DOC-2.03 : All documentation must be written in English.

What are the quality requirements?

After an analysis of Siconos software requirements, four priority software quality factors (Mc Call criteria) have been chosen. Each one has a mark of priority.

Environmental Requirements

What are the Data representation requirements?

What are the resource requirements?

RES-00: The recommended configuration is : processor 800 Mhz, 512 Mo Ram, 200 Mo of free space on HDD

What are the portability requirements?

Siconos should run on :
  • POR-1.00: PC / Linux environment from kernel 2.6
  • POR-1.01: PC / Windows environment Microsoft Windows XP
  • POR-1.02: Sun Workstation OS-Solaris environment Solaris
  • POR-1.03: Apple/Mac OS X 10.0 environment

The data must be portable:

  • POR-2.00 : ASCII data files must be defined with an unique charset.
  • POR-2.01 : BINARY data files must be defined with an IEEE format norm.

What application program interfaces (APIs) must be provided?