musip-midas

This is a MIDAS-based frontend for the Mupix11 based quad moduels.

📁 Project Structure

• analyzer/ – Analysis utilities
• custom/ – Custom pages for MIDAS
• docs/ – Documentation folder
• midas_fe/ – Core frontend source code
• tests/ – Unit tests for the project
• tools/ – Helper tools and scripts (mainly for the analyzer)
• .clang-format – Project-wide code style config
• mkdocs.yml – Setup for the documentation

Build Instructions

For a full installation guide go to: Setup

Prerequisites

• CMake ≥ 3.15
• C++17-compatible compiler (e.g. clang++, g++)
• MIDAS
• Python ≥ 3.7 (for scripts)

Build

mkdir build
cd build
cmake ..
make

Linting

Install clang-format and cpplint. The clang-format will clean the changed files while cpplint also gives some more static analysis.

cd build
make clangformat
make cpplint

Testing

CMake will download googletests to run the tests.

cd build
./tests/sample_test
./tests/bits_utils_test
./tests/mutrig_config_test

There are also some test managed with pytest.

cd tests
pytest

Docs

We use mkdocs and doxygen for generating the documentation. You should have the doxygen package installed on your system, then:

pip install mkdocs
pip install mkdocs-material
pip install mkdoxy
pip install mkdocs-with-pdf

Once all these are installed one can generate the documentation via:

make doc_mkdocs
make serve_mkdocs