Contributing to mmCEsim
Contributing to mmCEsim is welcome! You may check out the project for remaining issues. You may pick up one and comment below the issue if you want to work on that.
C++ Code Style
The C++ code style is based on LLVM,
with additional configuration listed in
to format the code before committing.
Appropriate permission is needed.
On a Unix (Linux and macOS) system, you may use
chmod +x ./misc/format.
The project is configured with CMake, and the role of each folder is listed below.
include: C++ Header Files (
export: Header Files Concerning ALG Export
mmcesim: Files Needed by mmCEsim Binary
copy: Contents Directly Copied to Form Generated C++/Python/Matlab Code
tex: LaTeX Files for Report Generation
src: C++ Source Files (
export: Class Implementations Corresponding to Those in
ext: 3rd Party Resources
astyle: Format Generated C++ Code
fmt: C++ String Format (Like That in C++20)
yaml-cpp: Parse YAML Configuration (
test: Test Files Including
doc: Documentation (Currently Empty)
bin: Generated Binary Executable
misc: Miscellaneous Files
For more information, please refer to the project CONTRIBUTING and Wiki. The Doxygen documentation for C++ is also available.
VS Code Extension
Other Ways You can Contribute to mmCEsim
You may freely open an issue for bug reports.
You can also join discussions if you have questions about the use of mmCEsim or about the task-oriented mmWave channel estimation techniques.
Cite Our Works
Please cite our work if you use mmCEsim in your research and/or software. Citations are useful for the continued development and maintenance of this project.
You may view Citation for more information.