CREDO Python Source API DocumentationΒΆ

These are the API (Application Programming Interface) documents for CREDO, describing the Python classes and functions provided by the library and how they function. They are automatically generated from documentation strings “docstrings” in the CREDO Python source code - so in an interactive Python session you can access this same information using the help() function on objects in your session.

For users: you may wish to start with the Examples of how to use CREDO section, and then refer back to this API as you become more familiar with CREDO and need to look up details.

For developers: the Core CREDO Architecture section gives an initial overview of how the various sub-packages in CREDO relate and are integrated.

Note

As well as navigating via the contents below, you can also use the name-sorted Index of all functions and members, or the module-sorted Module Index.

API Documentation contents:

Project Versions

Previous topic

Running a CREDO script (either System testing or analysis) using PBS

Next topic

Model API

This Page