doc/en/notations.rst

   1 ..
   2    Copyright (C) 2008-2020 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. _section_notations:
  25
  26 Notations and common conventions
  27 ================================
  28
  29 In all this documentation, we use standard notations of linear algebra, data
  30 assimilation (as described in [Ide97]_) and optimization.
  31
  32 For algebraic formulations, vectors are written horizontally or vertically
  33 without making a difference. Matrices are written either normally, or with a
  34 condensed notation, consisting in the use of a space to separate the values,
  35 and a "``;``" to separate the rows of the matrix, in a continuous line.
  36
  37 Files can be indicated by an absolute or relative path. For some old or shared
  38 file systems, the full name with the path must not contain more than 256
  39 characters. In the case of Python files, it is advisable not to use dots in the
  40 name apart for the extension, to prevent difficulties in using it that are
  41 complicated to diagnose.
  42
  43 File type and naming conventions rely heavily on the extensions of the files
  44 themselves. Some of them are briefly specified here, without being exhaustive:
  45
  46 - extension ``.py``   : data or commands text file of Python source type
  47 - extension ``.comm`` : commands text file of EFICAS type
  48 - extension ``.xml``  : data text file of XML type or commands (for YACS, not exclusive)
  49 - extension ``.txt``  : data text file with space separator
  50 - extension ``.dat``  : data text file with space separator
  51 - extension ``.csv``  : data text file with comma or semicolon separator
  52 - extension ``.tsv``  : data text file with tab separator
  53 - extension ``.npy``  : data binary file of type Numpy mono-variable
  54 - extension ``.npz``  : data binary file of type Numpy multi-variables
  55 - extension ``.sdf``  : data binary file of type Scientific Data Format
  56
  57 .. ------------------------------------ ..
  58 .. include:: snippets/Header2Algo07.rst
  59
  60 - [Asch16]_
  61 - [Bouttier99]_
  62 - [Ide97]_
  63 - [WikipediaMO]_