Developer guide

These pages explain how the M3Resp code is organized and how to add to it. Read the contribution guide before you open a pull request.

Set up the code

The recordings in tests/data are stored with Git LFS, so install git-lfs before you clone the repository. Install M3Resp from the source folder with the EIT and EMG packages and the developer tools. Then run the tests:

python -m pip install -e ".[all,dev,docs]"
pytest

Pages

Page	Contents
Architecture	The two kinds of data objects, the folders of the code, and the folder for each kind of new code
Adapters	How M3Resp calls eitprocessing and resurfemg, and changes their results into M3Resp objects
Preset contracts	What a preset does, and how it differs from a workflow file
Testing	The test folders, the comparison tests with the two packages, the synthetic test data, and how to run the tests
Coding guidelines	Rules for the arguments, return values and names of functions
Offset estimation	The tools that find the time offset between two recordings
Processing defaults	The default settings of the EIT, EMG and ventilator processing, side by side
Migration guide	How to change code that calls eitprocessing or resurfemg into M3Resp code
Project stages	The stages of the project and the planned changes

Continue with Architecture.