This page provides links to the detailed documentation of the general concepts (software, data administration), scripting using Batch/Python/C++, OPALS software framework related issues (logging, parameters, filters, format definitions), and the handling of standardized and user-defined data formats. Furthermore, the developer oriented documentation can also be accessed from this page.
Concepts
Scripting
- Section Workflow Management provides basic information for using OPALS in a scripting environment
- Section Using Python Bindings specifically describes how to use the OPALS python interface
- Section Using C++ Bindings deals with embedding OPALS modules in customized C++ programs
- Section Parallel Processing demonstrates how to fully utilize powerful workstations and HPC
- Section opalsTask A processing concept to utilise multiple machines
- Section Package Scripts provides a list of all OPALS python package scripts
OPALS framework
Data formats
Developer oriented documentation
- Section C++ API Reference contains the detailed OPALS module class documentation (public functions, parameters, etc.) within OPALS
- Section Developer documentation contains developer oriented documentation
Miscellaneous