Opened 15 years ago

Closed 15 years ago

#36 closed enhancement (fixed)

Necessidade de pequeno tutorial para emso2ml.m

Reported by: Rodolfo Rodrigues Owned by: Rafael de Pelegrini Soares
Priority: minor Milestone:
Component: EMSO Version: 0.9.50
Keywords: Cc:

Description

Seria interessante se adicionar um comentário com instruções no arquivo emso2ml.m, de forma que com um comando básico de help emso2ml o usuário tenha informações gerais do arquivo e de como usá-lo. O mesmo seria válido para o arquivo emso2sci.sci.

Change History (3)

comment:1 Changed 15 years ago by Rodolfo Rodrigues

Uma sugestão:

%
%  [dev]=emso2ml(file)
%
%  EMSO2ML reads the data from the EMSO's result file
%  to the MATLAB variables.
%
%  For example,
%  If you have a 'FlowSheet' which contains a 'DIVICES'
%  called 'CSTR' and you want to plot the variable 'X'
%  (conversion) vs 'T' (temperature).
%  Firstly you must import the data:
%
%  » flowsheet = emso2ml('results.rlt');
%
%  where 'results.rlt' is the EMSO's result file of 
%  'FlowSheet'.
%  Thus you can plot using the PLOT function, p. ex.:
%
%  » plot(flowsheet.CSTR.T, flowsheet.CSTR.X);

%
%  Author and more infos
%

comment:2 Changed 15 years ago by Rafael de Pelegrini Soares

Adaptando para o padrão presente em outras funções do matlab e algumas pequenas modificações:

%EMSO2ML imports data from a EMSO's result file as a MATLAB structure.
%   FLOWSHEET=EMSO2ML(FILE) returns the structure FLOWSHEET containing
%   all elements of a previously saved EMSO's result FILE.
%   FILE should be a string with the path for the saved result.
%
%   Example:
%   If you have a 'FlowSheet' which contains a 'DEVICES' called 'CSTR'
%   and you have saved the simulation results in file 'results.rlt'
%   you can import the data with the following command:
%
%   >> flowsheet = emso2ml('results.rlt');
%
%   Then you can plot the CSTR temperature (T) vs. the conversion (X)
%   using the PLOT function:
%
%   >> plot(flowsheet.CSTR.T, flowsheet.CSTR.X);

comment:3 Changed 15 years ago by Rafael de Pelegrini Soares

Resolution: fixed
Status: newclosed

Enhancement implemented on the development version (0.9.52)

Note: See TracTickets for help on using tickets.