Home
Teddy van Jerry edited this page Apr 5, 2023
·
5 revisions
Welcome to the mmCEsim Wiki!
Note:
- This wiki is mainly for developers.
- Basic information about contributing to mmCEsim can be found at CONTRIBUTING.
- If you are the mmCEsim app user, you can find documentation, tutorial and other information at our website: https://mmcesim.org.
The project is configured with CMake, and the role of each folder is listed below.
-
include
: C++ Header Files (.h
)-
export
: Header Files Concerning ALG Export -
mmcesim
: Files Needed by mmCEsim Binary-
copy
: Contents Directly Copied to Form Generated C++/Python/Matlab Code -
tex
:$\rm\LaTeX$ Files for Report Generation
-
-
-
src
: C++ Source Files (.cpp
)-
export
: Class Implementations Corresponding to Those ininclude/export
-
-
ext
: 3rd Party Resources-
astyle
: Format Generated C++ Code -
fmt
: C++ String Format (Like That in C++20) -
yaml-cpp
: Parse YAML Configuration (.sim
)
-
-
test
: Test Files IncludingCTest
Configuration -
tools
: Accompanying Tools (log
,compose
andmaintain
) -
doc
: Documentation (Currently Empty) -
bin
: Generated Binary Executable -
misc
: Miscellaneous Files
Doxygen documentation is available at: https://dev.mmcesim.org.
The simulation configuration follows the YAML syntax.
- Documentation: https://mmcesim.org/doc/cli/config
The algorithm design file has extension .alg
, which uses our designed ALG language.
- Documentation: https://mmcesim.org/doc/alg
The mmCEsim workflow is shown below. We now only focus on the CLI app.
Copyright © 2022-2023 Wuqiong Zhao (Teddy van Jerry). Distributed by an MIT license.
- Home: Structure and Road Map
- Code Style: Use of Clang-Format
- Release Checklist