MATLAB: Path management for different versions of projects

idemanagementpathsource controlversion

Imagine that you develop a large Matlab program, which uses hundrets of functions. To keep the different modules independent from eachother, the corresponding functions are store in separate folders, e.g.:

 project1\gui\
 project1\calculations\
 project1\export\

During the development your create different version of e.g. the GUI and the export functions and get this hierarchy:

 project1\gui1.01\
 project1\gui1.02\
 project1\calculations\
 project1\export1.01\
 project1\export1.02\
 project1\export1.03\

Which tools are you using (do you recommend) to manage these folders in your MATLAB path? Do your tools consider dependencies, e.g. export1.03\ needs gui1.02\ or higher?

Due to the different folders GENPATH does not match. If you're working on project2\, project3\, etc., using the PATHTOOL and storing the different path strings does not work also, because the versions of the different projects cannot be set independently.

I've written a tool for this job, but it is far too specific and complex to be published. In addition it includes folders of the compiled MEX files for the different Matlab versions and patchs of the toolbox functions (e.g. a TYPECAST and BSXFUN for Matlab 6.5). Using a standard source control system helps to manage the files, but I did not find a comfortable method to care about the set of folders in the MATLAB path. Some of my projects are used for clinical studies and the users must be able to reproduce the results for 10 years after a publication. "Sorry, I cannot get my old source control system to run under Window 14" is not an option.

I think this is a common problem and therefore I'm interested in your solutions.

Best Answer

In my MyStartup.m I have a call to a function LOADPROJECTS that lets me choose projects, then the paths required gets added to the matlab path. To my LOADPROJECTS I also have EDITPROJECTS, ADDPROJECTS, etc. So I can set up the paths for Project6p5 then unset and set the paths for Project7p2p.

Maybe you're asking for something more extensive, but this covers my current needs to keep separate versions apart. I'd be very interested in hearing what others do.

Related Solutions

MATLAB: Creating a built in function

Don't put it on the Desktop, create a folder in your user area for MATLAB and then add that folder to the MATLABPATH and make permanent.

Then, do NOT make copies of these functions all over the place, you'll reference the one and only version (excepting of course, if you do have copies for various classes of inputs; there's a whole hierarchy of directory structure outlined for that purpose.

Secondly, don't even think of adding to or modifying TMW-supplied functions -- if you do that, as soon as you update you've got to do it all over again besides the confusion that ensues from having done.

If you are working on a specific project, create a working directory specifically for it and a script to move to/from that subdir and perhaps do some other housekeeping on the way...

My prototype for this purpose looks like

>> type PROJECT
function PROJECT(varargin)
% Set environment for given project work environment
% PROJ -- set working directory for PROJ data work
% Optional arguments
%   'quit' -- restore environment to normal working 
%             directory prior to initial invocation
%   'init' -- clear local persistent working directory
%             from present value for clean slate
%   'info' -- display current target data working directory
%             and present return working directory on 'QUIT'
persistent workpath
p='C:\Set\Desired\Path\String\Here';
% handle optional arguments, then quit
option=[varargin{:}];
if strncmpi(option,'init',3), clear workpath, return, end
if strncmpi(option,'info',3),
  fprintf('PROJ data location: %s\nFormer working dir: %s\n',p,workpath)
  return
end
if strncmpi(option,'quit',2), cd(workpath),return,end % restore working path
% save called-from directory if 1st invocation after 'init'
if isempty(workpath), workpath=cd; end
cd(p)             % go to working directory

I've not got fancy-enough to make it self-modifying; I have to go in and create a new one for each new project by replacing PROJECT/PROJ with appropriate names...I do generally use all caps for these and some name that is easily associated with the given project.

Between a base \work directory for run-of-the-mill sandbox, the \UTILS directory that contains my set of functions similar to yours described above, and the above for projects, I've yet to see a message about "change MATLAB folder..."

That's been over 20 years now and counting... :)

MATLAB: How to create a project reference to a specific revision of another project under SVN source control

This can be done by using SVN externals:

https://www.mathworks.com/help/simulink/ug/set-up-svn-source-control.html#bu62oes-1

This will allow you to create a subfolder in your current directory that contains a reference to another SVN repository. You may also choose the specific revision when creating the SVN external.

After creating this subfolder, you can create a project reference to the project inside the created sublfolder.

Alternatively, you may check out the specific revision of the project to-be-referenced, then create a project reference to the checked out copy.

Related Question