M2 Common Code in Python

Platform

• CentOS 8.9
• python: 3.11.6

Needed Package

• black (optional)
• flake8 (optional)
• isort (optional)
• mypy (optional)
• documenteer (optional)
• sphinxcontrib-plantuml (optional, install by pip)
• pytest (optional, install by conda)
• pytest-flake8 (optional, install by conda -c conda-forge)
• ts_config_mttcs (optional, this is to provide the test data)

Code Format

This code is automatically formatted by black using a git pre-commit hook (see .pre-commit-config.yaml). To enable this, see pre-commit.

Build the Document

To build project documentation, run package-docs build to build the documentation. To clean the built documents, use package-docs clean. See Building single-package documentation locally for further details.

Figure

The map of temperature sensors is here. See the MockControlClosedLoop._calc_temp_inv_matrix() for the details.

Unit Tests

You can run the unit tests by:

pytest tests/

You need to have the variable of TS_CONFIG_MTTCS_DIR assigned to get the test data.

Class Diagrams

The class diagrams are in here. You can use the PlantUML to read them. The environment variable PATH_PLANTUML is required to indicate the position of plantuml.jar. Otherwise, the default position will be used.

Note

The environment variable of TS_CONFIG_MTTCS_DIR is used to reach the disk position of test data (ts_config_mttcs) to adapt both package managers: conda and eups.