Skip to content

Commit

Permalink
Added info onn the describe method
Browse files Browse the repository at this point in the history
  • Loading branch information
uliw committed Dec 9, 2020
1 parent c324ddf commit 47a1efa
Showing 1 changed file with 7 additions and 16 deletions.
23 changes: 7 additions & 16 deletions Documentation/ESBMTK-Quick-Start_Guide.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 47a1efa

Please sign in to comment.