cape.pyus: US3D interfacesΒΆ

The cape.pyus module contains the top-level interface for US3D setup, execution, and post-processing. It loads some of the most important methods from the various submodules so that they are easier to access. Most tasks using the pyFun API can be accessed by loading this module and reading one instance of the cape.pyus.cntl.Cntl class.

import cape.pyus

For example the following will read in a global settings instance assuming that the present working directory contains the correct files. (If not, various defaults will be used, but it is unlikely that the resulting setup will be what you intended.)

import cape.pyus
cntl = cape.pyus.Cntl()

The following classes are imported in this module, so that code like pyFun.Cntl will work (although cape.pyfun.cntl.Cntl will also work).

Modules included within this one are outlined below.