User Tools

Site Tools


en:software:matlab:trepr:doc:howto:installation

Installing the Toolbox

Installation is fairly simple, and has become even simpler lately with the new trEPRinstall function.

Of course you could just unzip the toolbox and add the paths manually to Matlab, but using the new trEPRinstall function might have some advantages, as outlined below.

If in a hurry

(c) Wikipedia.org, Tkgd2007, (CC BY-SA 2.5) Get a ZIP archive of the toolbox, unzip it to a directory of choice, start Matlab, change to that directory where you unpacked the toolbox files to, change to the directory internal, type trEPRinstall and follow the dialogues. If you want to update an existing version of the toolbox, unzip the new files in the same directory and run trEPRinstall as well. This will update your local configuration files while preserving your personal settings. In any case, make sure that the installer could save the updated paths.

The installation routine trEPRinstall

Once you obtained the toolbox (in most cases a ZIP archive), unzip it to a directory of choice and change to that directory within the Matlab™ workspace.

From here, change to the directory internal and type trEPRinstall at the Matlab™ command line and follow the dialogues there:

>> cd internal
>> trEPRinstall

==================================================================

 WELCOME. This will install

     trEPR toolbox
     - a Matlab toolbox for transient absorption spectra  

 on your system.

==================================================================

Do you want to install the toolbox now? Y/n [Y]: 

This is the last chance to decide not to install the toolbox… ;-)

If you hit <key>Enter</key> or the <key>y</key> key (case doesn't matter), the installation programm will continue. Entering any other character will abort.

Please note: <key>Escape</key> and other special keys are not recognised by Matlab™ as valid answers. So if you want to abort, type any character that is not “y”.

If you decided to install, the installation routine will tell you about the progress:

Do you want to install the toolbox now? Y/n [Y]: y

Adding the following paths to the Matlab(tm) search path:

  /home/user/programs/Matlab/Toolboxen/trEPR/GUI
  /home/user/programs/Matlab/Toolboxen/trEPR/IO
  /home/user/programs/Matlab/Toolboxen/trEPR/analysis
  /home/user/programs/Matlab/Toolboxen/trEPR/common
  /home/user/programs/Matlab/Toolboxen/trEPR/doc
  /home/user/programs/Matlab/Toolboxen/trEPR/figure
  /home/user/programs/Matlab/Toolboxen/trEPR/internal
  /home/user/programs/Matlab/Toolboxen/trEPR/preprocessing

Saving path... done.

Congratulations! The trEPR Toolbox has been installed on your system.

Please, find below a bit of information about the current install.

==================================================================

 trEPR toolbox
 - a Matlab toolbox for transient absorption spectra  

 Release:         0.3.8 2012-04-23
 Directory:       /Users/till/Programme/Matlab/Toolboxen/trepr
 Matlab version:  7.13.0.564 (R2011b)
 Platform:        Mac OS X  Version: 10.6.8 Build: 10K549 

 Homepage:        http://till-biskup.de/en/software/matlab/trepr/
 Maintainer:      Till Biskup, <till@till-biskup.de>

 Bug tracker:     https://r3c.de/bugs/till/

==================================================================

Please note: The trEPRinstall routine tries to save the changes to the Matlab™ path, but if you are lucky to work on a real multi-user system with a central Matlab™ installation, you might not have write access to this file, called pathdef.m, that is normally located in $MATLABROOT/toolbox/local/, with $MATLABROOT being the directory your Matlab™ is installed in.

In this case the trEPRinstall routine will tell you that it had problems with writing the path, and that means that you have to do that manually. For more details about setting the Matlab™ path, refer to the Matlab™ help.

In any way it is highly recommended that you save the path, as otherwise you would have to run the installer every time you start Matlab™ to update the path and make Matlab™ aware of where the trEPR Toolbox is located. In short: The toolbox will not work if you don't set the paths correctly.

A note to updaters

If you unpack the new version of the toolbox in the same directory as an existing one, it is wise to call once trEPRinstall as well to get the configuration files updated (and to add any path that might be new in the latest toolbox version). This will not delete your configuration settings, but rather preserve them. For more details about configuration files, see the information about the configuration.

Please note: You can run the trEPRinstall routine from every path in the Matlab, as long as the previous installation has been added to the Matlab search path.

The trEPRinstall routine will recognise if this is the case, and therefore behave slightly different. What follows is a short explanation of the differences.

>> trEPRinstall

==================================================================

 WELCOME. This will update

     trEPR toolbox
     - a Matlab toolbox for transient EPR spectra  

 on your system.

==================================================================

Do you want to update the toolbox now? Y/n [Y]:

Did you notice the subtle difference to what is described above for the case of a new installation?

Once again, this is the last chance to decide not to update the toolbox - at least not to run trEPRinstall;-)

If you hit <key>Enter</key> or the <key>y</key> key (case doesn't matter), the installation programm will continue. Entering any other character will abort.

Please note: <key>Escape</key> and other special keys are not recognised by Matlab™ as valid answers. So if you want to abort, type any character that is not “y”.

If you decided to update, the installation routine will tell you about the progress:

Do you want to update the toolbox now? Y/n [Y]: y

Refreshing the following paths in the Matlab(tm) search path:

  /home/user/programs/Matlab/Toolboxen/trEPR/GUI
  /home/user/programs/Matlab/Toolboxen/trEPR/IO
  /home/user/programs/Matlab/Toolboxen/trEPR/analysis
  /home/user/programs/Matlab/Toolboxen/trEPR/common
  /home/user/programs/Matlab/Toolboxen/trEPR/doc
  /home/user/programs/Matlab/Toolboxen/trEPR/figure
  /home/user/programs/Matlab/Toolboxen/trEPR/internal
  /home/user/programs/Matlab/Toolboxen/trEPR/preprocessing

Saving path... done.

Updating configuration... 

  merging trEPRgui.ini
  merging trEPRgui_ACCwindow.ini
  merging trEPRgui_AVGwindow.ini

done.

Congratulations! The trEPR Toolbox has been updated on your system.

Please, find below a bit of information about the current install.

==================================================================

 trEPR toolbox
 - a Matlab toolbox for transient EPR spectra  

 Release:         0.3.8 2012-04-23
 Directory:       /Users/till/Programme/Matlab/Toolboxen/trepr
 Matlab version:  7.13.0.564 (R2011b)
 Platform:        Mac OS X  Version: 10.6.8 Build: 10K549 

 Homepage:        http://till-biskup.de/en/software/matlab/trepr/
 Maintainer:      Till Biskup, <till@till-biskup.de>

 Bug tracker:     https://r3c.de/bugs/till/

==================================================================

Here, the most crucial difference (between slight changes in the words) is the following block:

Updating configuration... 

  merging trEPRgui.ini
  merging trEPRgui_ACCwindow.ini
  merging trEPRgui_AVGwindow.ini

done.

What happens here is that the trEPRinstall function reads your local configuration files, matches their contents to the configuration from the distributed (and probably updated) configuration and writes the new configuration.

Whereas this does not guarantee a complete smooth transition, especially if there were major changes in the internal organisation of some configuration files, normally that should be better than having to do all local settings again after an update.

en/software/matlab/trepr/doc/howto/installation.txt · Last modified: 2020/09/30 21:35 by 127.0.0.1