Skip to content

DEVELOPPER'S MANUAL

Scope of this Manual

This manual documents the main structure of the code, to ease change, debugging and developpment of new releases.

The data flow between modules can be visualise on this digital twin data flow diagram

Installation

The documentation of the digital twin is using mkdocs and mkdocs plugins. To install all required packages, run the following command in your Anaconda environment:

python -m pip install -r requirements-docs.txt

Architecture

The digital twin folder architecture is:

  • root: hosts the installation files, and main progam
  • docs: hosts the software documentation
  • module: hosts the different modules
  • motor: hosts the motor characteristics files
  • test: hosts the software test files