Modules in this package

This package provides the following modules for use in Python programs:

• fwdpy: this is the main module/namespace
• fwdpy.internal: this module contains “implementation details” of functionality in other modules. Objects in this module may not be documented. Generally-speaking, a user should never need to interact with this stuff directly.

Notes on the documentation

This package is split up into several modules.

The “base” functionality is in the module fwdpy.fwdpy. This module is automatically loaded when fwdpy is imported into the name space ‘fwdpy’.

In other words, code like this will allow fwdpy.fwdpy.foo to be referred to as just fwdpy.foo:

import fwdpy

It is important to keep this in mind when reading the reference manual. Many objects will be documented as fwdpy.fwdpy.something but example code will refer to fwdpy.something, which is correct.

“Internal” modules

Some of the modules have “internal” as part of their name. These modules represent the inner workings of the C++ layer. As such, they are not intended to be called directly by people using this package. However, they are included in the documentation in order to provide docstring tests for the developer and to document their existence for other developers interested in extending the package.

Undocumented functions

Some functions are left intentionally undocumented. Some of these are ‘workhorse` that recieve an object of a derived type from a function whose arguments are specified in terms of base types. Others are tedious implementation details. Sometimes they may be found in the same ‘pyx’ file as functions calling them. However, if they are in a different ‘pyx’ file, there should be a comment as to where to find them.