You're reading an old version of this documentation. For up-to-date information, please have a look at v0.5.

API documentation

This is the definite source of information for developers, besides having a look at the actual source code. Each class and public method should be fully documented.

Besides information necessary for the developer, the modules increasingly contain information on the context the classes implemented may be used. This is particularly true for the processing and analysis steps.

Subpackages

An alphabetic list of the subpackages available within the cwEPR package. The actual documentation is split in pages for each submodule of each subpackage, respectively.

• cwepr.io package
  • cwepr.io.bes3t module
  • cwepr.io.exporter module
    • Exporters
  • cwepr.io.factory module
  • cwepr.io.magnettech module

Submodules

An alphabetic list of the submodules available within the cwEPR package. The actual documentation is split in pages for each submodule, respectively.

• cwepr.analysis module
• cwepr.dataset module
• cwepr.exceptions module
• cwepr.metadata module
• cwepr.plotting module
• cwepr.processing module
• cwepr.report module