Screening report in HTML format
The Codee report
is a recently added feature that allows generating a project's
screening
report in HTML format, making it easier to view the results in a more
user-friendly way.
Before following this guide, we recommend checking out our quickstart guides to get familiar with all the other available Codee commands.
Getting ready
For this demonstration, we will use the Fortran implementation of MATMUL. Start by cloning the repository:
git clone https://github.com/codee-com/codee-demos.git
Firstly, navigate to the source code directory:
- Linux
- Windows
cd codee-demos/Fortran/MATMUL
cd codee-demos\Fortran\MATMUL
How to generate the HTML report
The first step is to generate the compile_commands.json
file, as explained in our
quickstart guides. For this, we will use bear
as follows:
bear -- make
Once the compile_commands.json
file is generated the creation of the screening
report
in HTML format is as simple as running:
codee report -p compile_commands.json --out-dir output
Note: the compilation database entries will be analyzed in the order necessary to meet module dependencies between Fortran source files.
Configuration file 'compile_commands.json' successfully parsed.
Date: 2025-02-18 Codee version: 2025.1.1 License type: Modern
Performing Fortran module dependency analysis... Done
[1/3] matmul.f90 ... Done
[2/3] time.f90 ... Done
[3/3] main.f90 ... Done
HTML report completed. It is located at output
Additional configurations
In the command launched before, the --out-dir
flag is an optional. It allows users to specify where
the files generated by codee report
should be stored.