doc/en/notations.rst

   1 ..
   2    Copyright (C) 2008-2023 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 .. index:: single: File (naming)
  30 .. index:: single: File (type)
  31
  32 In all this documentation, we use standard notations of linear algebra, data
  33 assimilation (as described in [Ide97]_) and optimization.
  34
  35 For algebraic formulations, **vectors** are written horizontally or vertically
  36 without making a difference. **Matrices** can be written either normally as a
  37 serie of number series, either in text condensed notation, consisting in the
  38 use of a space to separate the values, and a "``;``" to separate the rows of
  39 the matrix, in a continuous line.
  40
  41 **Files** can be indicated by an absolute or relative path. For some old or
  42 shared file systems, the full name, including the path, must not contain more
  43 than 256 characters. In the case of Python files, it is advisable not to use
  44 dots in the name apart for the extension, to prevent difficulties in using it
  45 that are then complicated to diagnose.
  46
  47 **File type and naming conventions** rely heavily on the extensions of the
  48 files themselves. Some of them are briefly specified here, without being
  49 exhaustive:
  50
  51 - extension ``.py``   : data or commands text file of Python type
  52 - extension ``.comm`` : commands text file of ADAO EFICAS type
  53 - extension ``.xml``  : data text file of XML type or commands (for YACS, not exclusive)
  54 - extension ``.txt``  : data text file with space separator
  55 - extension ``.dat``  : data text file with space separator
  56 - extension ``.csv``  : data text file with comma or semicolon separator
  57 - extension ``.tsv``  : data text file with tab separator
  58 - extension ``.npy``  : data binary file of type Numpy mono-variable
  59 - extension ``.npz``  : data binary file of type Numpy multi-variables
  60 - extension ``.sdf``  : data binary file of type Scientific Data Format
  61
  62 For the use of some of these files, one can refer to the keyword "*DataFile*"
  63 as :ref:`section_ref_entry_types_info`.
  64
  65 .. ------------------------------------ ..
  66 .. include:: snippets/Header2Algo07.rst
  67
  68 - [Asch16]_
  69 - [Bouttier99]_
  70 - [Ide97]_
  71 - [WikipediaMO]_