From 47a1efa570ea8420d375d161299f6dd7e389fec0 Mon Sep 17 00:00:00 2001 From: uliw Date: Wed, 9 Dec 2020 13:18:02 -0500 Subject: [PATCH] Added info onn the describe method --- Documentation/ESBMTK-Quick-Start_Guide.org | 23 +++++++--------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/Documentation/ESBMTK-Quick-Start_Guide.org b/Documentation/ESBMTK-Quick-Start_Guide.org index ecf25a25..0580b15e 100644 --- a/Documentation/ESBMTK-Quick-Start_Guide.org +++ b/Documentation/ESBMTK-Quick-Start_Guide.org @@ -491,23 +491,14 @@ reservoir. F = F * a * F0 x C/(b+C) -** Connection Introspection - -Each reservoir keeps a list of it's connection objects. This list is accessible via the =list_connnections()= method -#+BEGIN_SRC ipython -Ocean.list_connections() -#+END_SRC - -Each connection keeps a list of it's processes -#+BEGIN_SRC ipython -connection.list_processes() -#+END_SRC - -In turn, the process names can be used to access the help system -#+BEGIN_SRC ipython -help(processname) -#+END_SRC +** Introspection +The object names can be used to query almost all object parameters. I +addition to the usual commands (e.g., =print=, =help=, =dir=), the +=model=, =reservoir= and =connection= classes provide a =describe()= +method. This method can be used e.g., to query the name and type of +the connections, fluxes and processes which are associated with a +reservoir. ** External Data