Welcome to PyDREAM’s documentation!

Quickstart: The main function to run DREAM is in pydream.core.run_dream().

This provides reasonable defaults, but a variety of options are available for customizing DREAM. These can be passed as keyword arguments to pydream.core.run_dream(). See the pydream.Dream.Dream class for a list of options.

Examples are available in the examples directory of the GitHub repo.

Contents:

• Installation
  • Requirements
• Module Reference
  • pydream.Dream module
  • pydream.core module
  • pydream.parameters module

Indices and tables

• Index
• Module Index
• Search Page