Demcompare high level description

Demcompare can be run through Demcompare CLI that uses Demcompare pipeline module.

With an input configuration file, Demcompare pipeline module orchestrates :

../../_images/modules_schema.png

Fig. 11 Modules relationship.

Demcompare API is also detailed in notebooks and automatic API is generated in API Reference section.

Demcompare architecture combines simple python modules with python classes. To generalize some parts, some of those classes have an abstract architecture.

Demcompare’s abstraction are all implemented with the following structure:

  1. The class factory, which is python file named like the class. It only handles the class object generation.

  2. The abstract class template, which is a python file named like the class + “_template”. This file includes all the abstract functions and attributes.

  3. The subclasses, which are python files implementing the subclasses derived from the abstract class. With the class factory and the abstract class template, different subclasses can be implemented deriving from the abstract class template.