Skip to content

Commit

Permalink
adding comment in ComputationalGraphTool
Browse files Browse the repository at this point in the history
  • Loading branch information
@xavierr
xavierr committed Dec 5, 2024
1 parent 517fa5b commit f9f326f
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion Utilities/ComputationalGraph/ComputationalGraphTool.m
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
classdef ComputationalGraphTool

%
% A model is essentially characterised by its computational graph. The functions to setup the graph of a model are given in the BaseModel class.
%
% The ComputationalGraphTool is used to store the computational graph and provides utility functions to explore it in an iteractive way.
%
% From a model, you can get the computatonial graph by writing in the terminal
%
% cgt = model.cgt
%
% Then write
%
% cgt.help

% to get an overview of the different commands that are available.
%
properties (SetAccess = private)

model
Expand Down

0 comments on commit f9f326f

Please sign in to comment.