Merge pull request #234 from Picaut/master

Update documentation

Docs/I_Simpa_overview.rst

@@ -0,0 +1,253 @@
+I-Simpa overview
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+I-Simpa alone is **not a calculation software**, but is equivalent to a pre and post-processor
+for acoustic codes. One or more numerical codes must be added in order to obtain a fully functional system.
+
+At the present time, **I-Simpa is distributed with two codes**:
+
+- `TCR code`_ based on the classical theory of reverberation
+- `SPPS code`_ based on particle tracing approach
+
+The resume of `all code characteristics are given here`_
+
+.. _`TCR code`: code_TCR.html
+.. _`SPPS code`: code_SPPS.html
+.. _`all code characteristics are given here`: code_characteristics.html
+
+Classical applications are room and building acoustics, environmental noise and industrial noise, but it can be easily extend to other applications concerning the sound propagation in 3D environments (interior of vehicle, sound in cavities…).
+
+I-Simpa has been initially developed as a research tool (i.e. for research laboratories), but can also be a very efficient tool for a professional/commercial use, as well as for education.
+
+**Functionnal**
+	Elements and components are organized in tree structures, to easily access to all information, parameters and properties. Many features are proposed for helping users
+
+**Open system**
+	All information and data are organized in spreadsheets that can be displayed, exported, copied… User can use their own software for processing data and graphical representation.
+
+**Open software**
+	User can integrate their own numerical propagation code, develop their own functionalities within the interface, using Python scripts… All have been done in order you can extend I-Simpa easily.
+
+**Open source project**
+	The source code of I-Simpa is freely available on the GitHub plateform (https://github.com/Ifsttar/I-Simpa). There are many way for the community to contribute to the development of I-Simpa.
+
+I-Simpa features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Geometry
+------------------
+
+
+.. image:: images/features/Import_geometry.png
+	:align: left
+	:width: 140px
+
+
+Import 3D files
+	Import 3D files with common extensions: 3DS (3D Studio), STL (stereolithography), PLY (Stanford) and POLY (TetGen).
+
+,,,,
+
+
+.. image:: images/features/Correction_model.png
+	:align: left
+	:width: 140px
+
+Geometry correction
+	Automatic tools for model corrections and repairs during file importation. Model detection error.
+
+,,,,
+
+
+.. image:: images/features/geometry_approximation.png
+	:align: left
+	:width: 140px
+
+Geometry approximation
+	Algorithm for model approximation by the marching cube method. This can be useful for original 3D scene with many problems.
+
+,,,,
+
+
+.. image:: images/features/creating_scene.png
+	:align: left
+	:width: 140px
+
+
+Parallelepipedic geometry
+	Built-in design of parallelepipedic model. Just gives the dimensions of the scene.
+
+,,,,
+
+Surface material
+---------------------
+
+
+.. image:: images/features/import_material.png
+	:align: left
+	:width: 140px
+
+Import data material
+	Import data from file (import from CATT-Acoustic™ and Odeon room acoustics software).
+
+,,,,
+
+
+.. image:: images/features/manipulate_materials.png
+	:align: left
+	:width: 140px
+
+Reference and User material database
+	Use the built-in database (Reference) or create your own materials (User database). Organize and copy material between (sub-)groups of material.
+
+,,,,
+
+
+.. image:: images/features/material_properties.png
+	:align: left
+	:width: 140px
+
+Material properties
+	Define acoustic parameters by frequency band: absorption, transmission loss, scattering, scattering reflection law. Add material information (description, physical parameters...).
+
+,,,,
+
+Sound sources
+---------------------
+
+.. image:: images/features/spectrum_data.png
+	:align: left
+	:width: 140px
+
+Reference and User spectrum database
+	Use the built-in database (Reference) or create your own source spectrum (User database).
+
+,,,,
+
+.. image:: images/features/source_properties.png
+	:align: left
+	:width: 140px
+
+Sources properties
+	Define source properties: spectrum, position, directivity, delay, activate/desactivate sources.
+
+,,,,
+
+.. image:: images/features/Manipulate_sources.png
+	:align: left
+	:width: 140px
+
+Sources manipulation
+	Organize and copy sources between (sub-)groups of material. Translation and rotation of (sub-)groups of sound sources.
+
+,,,,
+
+Acoustic receivers
+---------------------
+
+
+.. image:: images/features/Punctual_receiver_properties.png
+	:align: left
+	:width: 140px
+
+Punctual sound sources
+	Defines source properties: position, directivity, orientation to a point or (with a dynamic link) to a source, background noise.
+
+,,,,
+
+.. image:: images/features/manipulate_punctual_receivers.png
+	:align: left
+	:width: 140px
+
+Receivers manipulation
+	Organize and copy receivers between (sub-)groups of material. Translation and rotation of (sub-)groups of receivers.
+
+,,,,
+
+.. image:: images/features/surface_receiver.png
+	:align: left
+	:width: 140px
+
+Surface receivers
+	Definition of a surface receiver by selecting surfaces of the 3D model or by creating cut planes.
+
+,,,,
+
+
+Acoustic calculation
+---------------------
+
+.. image:: images/features/calculation_codes.png
+	:align: left
+	:width: 140px
+
+Calculation code
+	Built-in acoustic calculation code: sound particle tracing (SPPS); Classical theory of reverberation for room acoustics (TCR).
+
+,,,,
+
+.. image:: images/features/sound_map.png
+	:align: left
+	:width: 140px
+
+Sound map
+	Noisemap (surface receivers) in stationary stationary state, time-varying state, time-cumulated state. Iso-contours.
+
+,,,,
+
+.. image:: images/features/acoustical_parameters.png
+	:align: left
+	:width: 140px
+
+Acoustics parameters
+	:term:`EN ISO 3382-1` room acoustics parameters: Reverberation times, Clarity, Definition, Early support, Centre time, Strength, Early Lateral Energy Fraction, Late Lateral Sound Level.
+
+,,,,
+
+.. image:: images/features/result_animation.png
+	:align: left
+	:width: 140px
+
+Animation
+	Intensity vectors animation for punctual receivers. Ray-tracing and particle-tracing animation.
+
+,,,,
+
+
+Other features
+---------------------
+
+
+.. image:: images/features/python_script.png
+	:align: left
+	:width: 140px
+
+Python™ scripting
+	Extension of I-Simpa functionalities using Python scripts. Creations of Toolbox.
+
+,,,,
+
+.. image:: images/features/environmental_data.png
+	:align: left
+	:width: 140px
+
+Environmental data
+	Definition of atmospheric conditions and calculation of absorption coefficient (:term:`ISO 9613-1`). Meteorological parameters (log-lin sound speed velocity profiles).
+
+,,,,
+
+.. image:: images/features/meshing.png
+	:align: left
+	:width: 140px
+
+Tetrahedric meshing
+	Built-in Delaunay tetrahedric meshing using TetGen code (fully parametrized).
+
+,,,,
+
+.. image:: images/features/fitting_zone.png
+	:align: left
+	:width: 140px
+
+Fitting zone
+	Definition of volumes with fitting objects characterized by probabilistic parameters (:term:`mean free path`, absorption, diffusion law).

Docs/I_Simpa_standard.rst

@@ -4,32 +4,73 @@ Standards
 Acoustics
 ----------
 
-ISO 9613-1:1993, Acoustics -- Attenuation of sound during propagation outdoors -- Part 1: Calculation of the absorption of sound by the atmosphere
-http://www.iso.org/iso/catalogue_detail.htm?csnumber=17426
+.. glossary::
+
+   ISO 9613-1
+      ISO 9613-1:1993, Acoustics -- Attenuation of sound during propagation outdoors -- Part 1: Calculation of the absorption of sound by the atmosphere
+      http://www.iso.org/iso/catalogue_detail.htm?csnumber=17426
+
+   ISO 3382-1
+      ISO 3382-1:2009, Acoustics -- Measurement of room acoustic parameters -- Part 1: Performance spaces
+      http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=40979
+
+   NF S31-133
+      NF S31-133:2011, Acoustics -- Outdoor noise - Calculation of sound levels
+      https://www.boutique.afnor.org/norme/nf-s31-133/acoustique-bruit-dans-l-environnement-calcul-de-niveaux-sonores/article/678966/fa169343
+
+   ISO 354
+      ISO 354:2003, Acoustics -- Measurement of sound absorption in a reverberation room
+      https://www.iso.org/standard/34545.html
+
+   ISO 10534-1
+      ISO 10534-1:1996, Acoustics -- Determination of sound absorption coefficient and impedance in impedance tubes -- Part 1: Method using standing wave ratio
+      https://www.iso.org/standard/18603.html
+
+   ISO 10534-2
+      ISO 10534-2:1998, Acoustics -- Determination of sound absorption coefficient and impedance in impedance tubes -- Part 2: Transfer-function method
+      https://www.iso.org/standard/22851.html
+
+   ISO 17497-1
+      ISO 17497-1:2004, Acoustics -- Sound-scattering properties of surfaces -- Part 1: Measurement of the random-incidence scattering coefficient in a reverberation room
+      https://www.iso.org/standard/31397.html
+
+   ISO 17497-2
+      ISO 17497-2:2012, Acoustics -- Sound-scattering properties of surfaces -- Part 2: Measurement of the directional diffusion coefficient in a free field
+      https://www.iso.org/standard/55293.html
+
+   ISO 266
+      ISO 266:1997, Acoustics -- Preferred frequencies
+      https://www.iso.org/standard/1350.html
+
+   EN ISO 3382-1
+      ISO 3382-1:2009, Acoustics -- Measurement of room acoustic parameters -- Part 1: Performance spaces
+      https://www.iso.org/standard/40979.html
 
-ISO 3382-1:2009, Acoustics -- Measurement of room acoustic parameters -- Part 1: Performance spaces
-http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=40979
 
-NF S31-133 February 2011, Acoustics - Outdoor noise - Calculation of sound levels
-https://www.boutique.afnor.org/norme/nf-s31-133/acoustique-bruit-dans-l-environnement-calcul-de-niveaux-sonores/article/678966/fa169343
 
 Other
 -----
 
-NF ISO 639-1 February 2003, Codes for the representation of names of languages - Part 1 : Alpha-2 code
-https://www.boutique.afnor.org/standard/nf-iso-639-1/codes-for-the-representation-of-names-of-languages-part-1-alpha-2-code/article/742951/fa104093
+   ISO 639-1
+      NF ISO 639-1:2003 -- Codes for the representation of names of languages - Part 1 : Alpha-2 code
+      https://www.boutique.afnor.org/standard/nf-iso-639-1/codes-for-the-representation-of-names-of-languages-part-1-alpha-2-code/article/742951/fa104093
 
-NF ISO 639-2 December 1999, Codes for the representation of names of languages - Part : alpha-3 code
-https://www.boutique.afnor.org/standard/nf-iso-639-2/codes-for-the-representation-of-names-of-languages-part-alpha-3-code/article/727490/fa043864
+   ISO 639-2
+      NF ISO 639-2:1999 -- Codes for the representation of names of languages - Part : alpha-3 code
+      https://www.boutique.afnor.org/standard/nf-iso-639-2/codes-for-the-representation-of-names-of-languages-part-alpha-3-code/article/727490/fa043864
 
-NF ISO 639-3 April 2007, Codes for the representation of names of languages - Part 3 : alpha-3 code for comprehensive coverage of languages
-https://www.boutique.afnor.org/standard/nf-iso-639-3/codes-for-the-representation-of-names-of-languages-part-3-alpha-3-code-for-comprehensive-coverage-of-languages/article/752747/fa138697
+   ISO 639-3
+      NF ISO 639-3:2007 -- Codes for the representation of names of languages - Part 3 : alpha-3 code for comprehensive coverage of languages
+      https://www.boutique.afnor.org/standard/nf-iso-639-3/codes-for-the-representation-of-names-of-languages-part-3-alpha-3-code-for-comprehensive-coverage-of-languages/article/752747/fa138697
 
-NF ISO 639-4 September 2010, Codes for the representation of names of languages - Part 4 : general principles of coding of the representation of names of languages and related entities, and application guidelines
-https://www.boutique.afnor.org/standard/nf-iso-639-4/codes-for-the-representation-of-names-of-languages-part-4-general-principles-of-coding-of-the-representation-of-names-of-lan/article/724011/fa138698
+   ISO 639-4
+      NF ISO 639-4:2010 -- Codes for the representation of names of languages - Part 4 : general principles of coding of the representation of names of languages and related entities, and application guidelines
+      https://www.boutique.afnor.org/standard/nf-iso-639-4/codes-for-the-representation-of-names-of-languages-part-4-general-principles-of-coding-of-the-representation-of-names-of-lan/article/724011/fa138698
 
-NF ISO 639-5 July 2008, Codes for the representation of names of languages - Part 5 : Alpha-3 code for language families and groups
-https://www.boutique.afnor.org/standard/nf-iso-639-5/codes-for-the-representation-of-names-of-languages-part-5-alpha-3-code-for-language-families-and-groups/article/645452/fa138699
+   ISO 639-5
+      NF ISO 639-5:2008 -- Codes for the representation of names of languages - Part 5 : Alpha-3 code for language families and groups
+      https://www.boutique.afnor.org/standard/nf-iso-639-5/codes-for-the-representation-of-names-of-languages-part-5-alpha-3-code-for-language-families-and-groups/article/645452/fa138699
 
-NF ISO 639-6 January 2010, Codes for the representation of names of languages - Part 6 : alpha-4 code for comprehensive coverage of language variants
-https://www.boutique.afnor.org/standard/nf-iso-639-6/codes-for-the-representation-of-names-of-languages-part-6-alpha-4-code-for-comprehensive-coverage-of-language-variants/article/699300/fa148722
+   ISO 639-5
+      NF ISO 639-6:2010 -- Codes for the representation of names of languages - Part 6 : alpha-4 code for comprehensive coverage of language variants
+      https://www.boutique.afnor.org/standard/nf-iso-639-6/codes-for-the-representation-of-names-of-languages-part-6-alpha-4-code-for-comprehensive-coverage-of-language-variants/article/699300/fa148722