Getting Started

EyNuel edited this page Jan 29, 2013 · 15 revisions

The easiest way to try out cTraceo is by running one of the 40+ example cases included in the distribution package.
You can download the latest version's source code, examples and PDF manual as a zip file or as a tarball. Precompiled binaries for Windows and Linux are also available in the downloads section, but you will probably still require the Matlab examples contained in the source package. You may also want to take a look at the notes on available cTraceo branches (versions).

Input Files:

Although cTraceo reads a text file containing the waveguide properties, there generally is no need to write this file manually. Instead, use the provided M-File wtraceoinfile.m to generate this file from within Matlab and then call the model, as is done in the examples.

Output files:

The [content of the output files](Output Files) depends on the output options specified in the input file and is described [here](Output Files).
The user may specify a custom file name for the output file by passing the --outputFileName <name> command line option when running the model's executable. If no name is specifyed for the output file, cTraceo will use the following default file names:

  • Ray coordinates: rco.mat
  • All Ray Information: ari.mat
  • Eigenrays: eig.mat
  • Coherent Acoustic Pressure: cpr.mat
  • Particle Velocity: pvl.mat
  • Coherent Acoustic Pressure and Particle Velocity: pav.mat

When running the model without any input options, it should output something like this:

$> ctraceo

* =========================================================================== *
*          The cTraceo Acoustic Raytracing Model, Version 1.3 Beta            *
*                                                                             *
* --------------------------------------------------------------------------- *
* Website:                                                                    *
*          https://github.com/EyNuel/cTraceo/wiki                             *
*                                                                             *
* License: The cTraceo Acoustic Raytracing Model is released under the        *
*          Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported *
*          License ( http://creativecommons.org/licenses/by-nc-sa/3.0/ )      *
*                                                                             *
* NOTE:    cTraceo is research code under active development.                 *
*          The code may contain bugs and updates are possible in the future.  *
*                                                                             *
* Written for project SENSOCEAN by:                                           *
*          Emanuel Ey                                                         *
*          emanuel.ey@gmail.com                                               *
*          Copyright (C) 2011, 2012                                           *
*          Signal Processing Laboratory                                       *
*          Universidade do Algarve                                            *
*                                                                             *
* cTraceo is the C port of the FORTRAN 77 TRACEO code written by:             *
*          Orlando Camargo Rodriguez:                                         *
*          Copyright (C) 2010                                                 *
*          Orlando Camargo Rodriguez                                          *
*          orodrig@ualg.pt                                                    *
*          Universidade do Algarve                                            *
*          Physics Department                                                 *
*          Signal Processing Laboratory                                       *
*                                                                             *
* ----------------------------------------------------------------------------*
*  Usage:                                                                     *
*          $> ctraceo [options] <filename>                                    *
*                                                                             *
*  Mandatory arguments:                                                       *
*          filename            The input file's name, without it's extension. *
*                                                                             *
*  Options:                                                                   *
*          --noLog             Do not write a log file.                       *
*                                                                             *
*          -h, --help          Show this text.                                *
*                                                                             *
*          -s <#>, --ssp <#>   Generate the interpolated sound speed profile  *
*                              as used by the model and save it as 'ssp.mat'. *
*                              The number # is the number of SSP points to    *
*                              generate and should be a positive integer.     *
*                                                                             *
*          --stdin             Read input file from stdin instead of reading  *
*                              it from disk.                                  *
*                                                                             *
*          -v, --version       Show version.                                  *
*                                                                             *
*          --killBackscatteredRays                                            *
*                              terminates a ray's propagation as soon as it   *
*                              inverts it's  horizontal travel direction      *
*                              The number of affected rays will be stored in  *
*                              the resulting matfile as 'nBackscatteredRays'. *
*                                                                             *
*          --noHeader          Disables the output of cTraceo's header. Can   *
*                              be used to keep logs smaller.                  *
*                                                                             *
*          --outputFileName <name>                                            *
*                              Specify a different file name for the output   *
*                              Generated by cTraceo.                          *
*                                                                             *
*  For more information visit our wiki, check out the readme.txt, read the    *
*  manual.pdf or contact the authors.                                         *
*                                                                             *
* =========================================================================== *

No input file provided.
Aborting...
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.