Installation¶
This section describes how to set up the Toksys/PCSSP tools for use by your Matlab session. Many users will want to use only the installed versions of these toolboxes. Standard installation of Toksys/PCSSP at sites outside of GA is done by Brian Sammuli (sammuli@fusion.gat.com) in coordination with system administrators at each installation site. However, if you want to be able to make changes to existing Toksys functions or add new functions and submit the modified or new functions to the Toksys code base, you will need to use a version of Toksys cloned from the Git repository.
Using previously installed Toksys and PCSSP¶
Add the directory <toksys_root>/startups, where <toksys_root> is the installed TokSys root directory, to the linux environment variable MATLABPATH. For example, at D3D the command would be
export MATLABPATH=/fusion/projects/codes/toksys/GAtools:$MATLABPATH
setenv MATLABPATH /fusion/projects/codes/toksys/GAtools:$MATLABPATH
To start using TokSys start Matlab and run
>> toksys_startup
Note
On iris and saturn at D3D, the command module load toksys steps up the environmental variables for you, but requires that you run module load matlab first.
Using custom version of Toksys (and of PCSSP if desired)¶
The easiest method is to clone it into the TokSys directory tree, e.g.:
git clone git@odin.gat.com:TOKSYS/toksys.git
cd toksys
git clone ssh://git@git.iter.org/pcs/pcssp.git
makeit
makeit command performs the actions necessary to compile all S-functions in the Toksys and PCSSP directory trees.
Alternatively, the PCSSP directory can be in a different location (either installed or cloned), in which case you can simply provide a link to it in the TokSys directory structure, e.g:
git clone git@odin.gat.com:TOKSYS/toksys.git
cd toksys
ln -s <pcssp_root> pcssp
makeit
<pcssp_root> is the root directory of the cloned (or installed) PCSSP directory tree
The instructions above provide the necessary steps to make the Toksys/PCSSP tool sets usable and to add their locations to the search path in your Matlab session. If, in addition, you want to use these tools to perform modeling, control design, or analysis for a particular device, you will also need to type (in Matlab):
>> <device_name>_startup
>> d3d_startup
>> kstar_startup
startup.m in your directory ~/matlab containing the line toksys_startup