The module "mtvroot" of the Mastrave modelling library

Copyright and license notice of the function mtvroot

Copyright © 2008,2009,2010,2011 Daniele de Rigo

The file mtvroot.m is part of Mastrave.

Mastrave is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Mastrave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Mastrave. If not, see http://www.gnu.org/licenses/.

Function declaration

root_path = mtvroot( domain = 'mtv' )

Description

Utility function to return the installation root path of the domain domain (which can be the entire computing environment of a specific library).

Input arguments

 domain          ::string::
                 Domain whose installation root path is needed.
                 (Default value: 'mtv' ).
                 Valid options are:

                       option   │    meaning
                    ────────────┼──────────────────────────────────────
                       'mtv'    │ Return the installation root path
                                │ of the Mastrave project.
                    ────────────┼──────────────────────────────────────
                       'env'    │ Return the installation root path
                                │ of the computing environment which
                                │ is interpreting the function (e.g.
                                │ if the function is run within the
                                │ GNU Octave interpreter, it will
                                │ return the value of OCTAVE_HOME).

Example of usage

   fprintf( 1 , 'The environment root path is %s\n' , mtvroot( 'env' ) )

   fprintf( 1 , 'The Mastrave root path is %s\n'    , mtvroot( 'mtv' ) )

See also:
   fileinfo, munix



Keywords:
   filesystem, configuration, maintenance 



Version: 0.2.7

Support

The Mastrave modelling library is committed to provide reusable and general - but also robust and scalable - modules for research modellers dealing with computational science.  You can help the Mastrave project by providing feedbacks on unexpected behaviours of this module.  Despite all efforts, all of us - either developers or users - (should) know that errors are unavoidable.  However, the free software paradigm successfully highlights that scientific knowledge freedom also implies an impressive opportunity for collectively evolve the tools and ideas upon which our daily work is based.  Reporting a problem that you found using Mastrave may help the developer team to find a possible bug.  Please, be aware that Mastrave is entirely based on voluntary efforts: in order for your help to be as effective as possible, please read carefully the section on reporting problems.  Thank you for your collaboration.