Welcome to Code_TYMPAN developers documentation

Code_TYMPAN is a C++ Open Source acoustic simulation code. It deals with propagation acoustic waves in an industrial site. It provides different numerical solvers and a Qt5 graphical user interface to create and display your site: buildings, fields, machines, acoustic sources, to launch a simulation and display some results.

Description of the environment and conventions

• Architecture (4.x version)
• Python Data Model
• Structure of the code base (ToDo update)
• Executables (ToDo update)
• Conventions
• Tools

Main developers’ tasks

• Installation
• Build system configuration
• Testing
• Debugging and diagnosis strategies
• Windows installer (ToDo Update)
• Debian jessie packaging (ToDo Update)

Computations and algorithms

• Building the mesh seen by the solvers
• The Ray Tracing Algorithm
• Accelerating structures for efficient intersection computation

Documentation

• C++ documentation by Doxygen
• C++ documentation by Breathe (ToDo)
• Python API documentation

Appendices

• Ongoing work