diff --git a/matlab/AnalyseComputationalEnviroment.m b/matlab/AnalyseComputationalEnviroment.m index ac784f840..f29490a41 100644 --- a/matlab/AnalyseComputationalEnviroment.m +++ b/matlab/AnalyseComputationalEnviroment.m @@ -1,12 +1,8 @@ - function [ErrorCode] = AnalyseComputationalEnviroment(DataInput) - -%%%%%%%% INFORMATIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - % Input/Output description: - +% % DataInput is the strcture option_.parallel, with the follow fields: - +% % Local Define the computation place: 1 is on local machine, 0 remote % PcName Intuitive: contain the computer name. % NumCPU Intuitive: contain the CPU number. @@ -14,25 +10,25 @@ function [ErrorCode] = AnalyseComputationalEnviroment(DataInput) % passwd Intuitive: contain the password for the user name in PcName. % RemoteDrive Drive used for Local/Remote computation (data exchange, etc) must be contain 'RemoteFolder'. % RemoteFolder Folder in RemoteDrive used for Local/Remote computation. - +% % This information is typed by the user using the *.mod file, % the goal of this function is to check if it correct. - - +% +% % The variable ErrorCode is initialized at 0. If there are non problems with % Local, PcName connections,... in general with parallel software execution, % the ErrorCode is unchanged, in the others cases 1, 2 , ... The values % table is below. - - +% +% % Table for ErrorCode Values. - +% % ErrorCode -> 0 Initial Value -> No Error Detected!!! % ErrorCode -> > 1 When an error happens. The value 1, 2, 3... are % used to specify the kind of error. - +% % Value 1: The variable 'Local' has a bad value! - +% % Value 2: The variable 'NumCPU' has a bad value. Parallel Dynare % require an input data like [s:d] with s<=d, in this case we % have s>d! @@ -45,13 +41,26 @@ function [ErrorCode] = AnalyseComputationalEnviroment(DataInput) % remote computer! % % Value 5: It is impossible write/read file on remote computer. - +% % Then at the point call of this function it is possible react in a best way, in accord % with the ErrorCode. - -%%%%%%%% END INFORMATIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +% Copyright (C) 2009 Dynare Team +% +% This file is part of Dynare. +% +% Dynare 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. +% +% Dynare 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 Dynare. If not, see . ErrorCode=0;