How to Read the Modules Documentation

Each chapter describes one of the main sub-packages of the fipy package. The sub-package fipy.package can be found in the directory fipy/package/. In a few cases, there will be packages within packages, e.g. fipy.package.subpackage located in fipy/package/subpackage/. These sub-sub-packages will not be given their own chapters; rather, their contents will be described in the chapter for their containing package.

• package.subpackage package
  • Submodules
  • package.subpackage.base module
    • Base
      • Base.method1()
      • Base.method2()
  • package.subpackage.object module
    • Object
      • Object.method1()
      • Object.method2()
  • Module contents

Last updated on Jun 27, 2023. Created using Sphinx 6.2.1.