README.txt

% =================================================================================================
% Sweep Toolbox
% =================================================================================================
%
% Define functions for:
%     - computing parameters combinations
%     - calling a function for each combinations
%     - parallel code for the computation
%     - support string and numeric combinations
%     - support grouping of combinations
%
% =================================================================================================
%
% Folder structure:
%     - sweep_example - test scripts
%     - sweep_lib - general for sweeping parameters
%     - get_sweep_combine.m - main class for the computation of multiple parameter combinations
%     - get_sweep_single.m - main class for the computation of a single parameter combination
%     - README.txt - this file
%
% =================================================================================================
%
% Getting started:
%     - sweep_example/test_sweep_combine.m - run a dummy simulation for multiple parameter combinations
%     - sweep_example/test_sweep_single.m - run a dummy simulation for a single parameter combination
%
% =================================================================================================
% (c) 2021, T. Guillod, BSD License
% =================================================================================================