Add NanoAOD markdown reports

[deinal]

PR description:

I've added the ability to produce content and collection-size reports of NanoAOD root files as markdown files. The script only produced html output before my changes, but markdown files are far more convenient if you want to include these report files in version control or display them in a repository on e.g. GitHub/GitLab.

Example content report:
https://github.com/deinal/nanoaod-reports/blob/main/collection-description.md

Example size report:
https://github.com/deinal/nanoaod-reports/blob/main/collection-size.md

PR validation:

My changes don't affect anything else. The script works on lxplus after executing cmsenv.

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-33097/21424

• This PR adds an extra 16KB to repository

[cmsbuild]

A new Pull Request was created by @deinal (Daniel Holmberg) for master.

It involves the following packages:

PhysicsTools/NanoAOD

@cmsbuild, @mariadalfonso, @gouskos, @fgolf can you please review it and eventually sign? Thanks.
@gpetruc, @peruzzim, @swertz this is something you requested to watch as well.
@silviodonato, @dpiparo, @qliphy you are the release manager for this.

cms-bot commands are listed here

[gouskos]

please test

[cmsbuild]

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-cbf541/13332/summary.html
COMMIT: 2cdcd8c
CMSSW: CMSSW_11_3_X_2021-03-07-2300/slc7_amd64_gcc900
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/33097/13332/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

@slava77 comparisons for the following workflows were not done due to missing matrix map:

• /data/cmsbld/jenkins/workspace/compare-root-files-short-matrix/data/PR-cbf541/34634.0_TTbar_14TeV+2026D76+TTbar_14TeV_TuneCP5_GenSimHLBeamSpot14+DigiTrigger+RecoGlobal+HARVESTGlobal
• /data/cmsbld/jenkins/workspace/compare-root-files-short-matrix/data/PR-cbf541/34834.999_TTbar_14TeV+2026D76PU_PMXS1S2PR+TTbar_14TeV_TuneCP5_GenSimHLBeamSpot14+PREMIX_PremixHLBeamSpot14PU+DigiTriggerPU+RecoGlobalPU+HARVESTGlobalPU

Summary:

• No significant changes to the logs found
• Reco comparison results: 4 differences found in the comparisons
• DQMHistoTests: Total files compared: 38
• DQMHistoTests: Total histograms compared: 2849195
• DQMHistoTests: Total failures: 6
• DQMHistoTests: Total nulls: 1
• DQMHistoTests: Total successes: 2849166
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: -0.004 KiB( 37 files compared)
• DQMHistoSizes: changed ( 312.0 ): -0.004 KiB MessageLogger/Warnings
• Checked 160 log files, 37 edm output root files, 38 DQM output files

[silviodonato]

@deinal have you already discussed about this at the @cms-sw/xpog-l2 meeting?

[deinal]

@silviodonato No, I haven't. I'm not part of that team so I can't open the link.

[kirschen]

@gouskos @mariadalfonso - Are you fine with this addition?

[silviodonato]

kind reminder @cms-sw/xpog-l2

[qliphy]

kindly ping @cms-sw/xpog-l2

[silviodonato]

enable profiling

[silviodonato]

please test

[cmsbuild]

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-cbf541/15938/summary.html
COMMIT: 2cdcd8c
CMSSW: CMSSW_12_0_X_2021-06-13-2300/slc7_amd64_gcc900
Additional Tests: PROFILING
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/33097/15938/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

• No significant changes to the logs found
• Reco comparison results: 3 differences found in the comparisons
• DQMHistoTests: Total files compared: 38
• DQMHistoTests: Total histograms compared: 2862520
• DQMHistoTests: Total failures: 6
• DQMHistoTests: Total nulls: 1
• DQMHistoTests: Total successes: 2862491
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: 0.004 KiB( 37 files compared)
• DQMHistoSizes: changed ( 312.0 ): 0.004 KiB MessageLogger/Warnings
• Checked 160 log files, 37 edm output root files, 38 DQM output files
• TriggerResults: no differences found

[cmsbuild]

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-cbf541/16154/summary.html
COMMIT: 2cdcd8c
CMSSW: CMSSW_12_0_X_2021-06-21-2300/slc7_amd64_gcc900
Additional Tests: PROFILING
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/33097/16154/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

• No significant changes to the logs found
• Reco comparison results: 4 differences found in the comparisons
• DQMHistoTests: Total files compared: 38
• DQMHistoTests: Total histograms compared: 2785631
• DQMHistoTests: Total failures: 6
• DQMHistoTests: Total nulls: 1
• DQMHistoTests: Total successes: 2785602
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: -0.004 KiB( 37 files compared)
• DQMHistoSizes: changed ( 312.0 ): -0.004 KiB MessageLogger/Warnings
• Checked 160 log files, 37 edm output root files, 38 DQM output files
• TriggerResults: no differences found

[silviodonato]

please test

[silviodonato]

(cms-sw/cms-bot#1567 is merged)

[cmsbuild]

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-cbf541/16587/summary.html
COMMIT: 2cdcd8c
CMSSW: CMSSW_12_0_X_2021-07-07-2300/slc7_amd64_gcc900
Additional Tests: PROFILING
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/33097/16587/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

• No significant changes to the logs found
• Reco comparison results: 5155 differences found in the comparisons
• DQMHistoTests: Total files compared: 38
• DQMHistoTests: Total histograms compared: 2786260
• DQMHistoTests: Total failures: 18
• DQMHistoTests: Total nulls: 1
• DQMHistoTests: Total successes: 2786219
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: -0.004 KiB( 37 files compared)
• DQMHistoSizes: changed ( 312.0 ): -0.004 KiB MessageLogger/Warnings
• Checked 160 log files, 37 edm output root files, 38 DQM output files
• TriggerResults: no differences found

[silviodonato]

@cms-sw/xpog-l2 we have finally the file size comparison for NanoAOD (11834.21). You have to enable the profiling (see #33097 (comment))

[mariadalfonso]

@deinal @kirschen
as you can see, we are moving the custom nano-profiling to the standard cms-sw profiling

the tools in PhysicsTools/NanoAOD/test are likely being dismissed soon.
Any reason why you keep developing this ?

[kirschen]

@deinal @kirschen
as you can see, we are moving the custom nano-profiling to the standard cms-sw profiling

the tools in PhysicsTools/NanoAOD/test are likely being dismissed soon.
Any reason why you keep developing this ?

Hi @mariadalfonso,
well, there hasn't been any development [needed] at all since Daniel put up this PR more than four(!) months ago. I suggested him to feed back what he had done for a "nanoAOD event content table" in a student report as an uncontroversial "first PR" to CMSSW as a fresh MSc student and was not aware of the profiling effort for checking PRs.
Not sure it's all that related, though: I found the HTML size report and documentation handy in the past myself and don't see anything wrong with having both of them available in Markdown as well. Not sure I get the reason why you want to remove the tool to quickly generate the doc+size report, but if you plan to get rid of inspectNanoFile.py now then expanding the functionality is probably indeed not very timely.

[mariadalfonso]

@kirschen
we can merge this one, but for the future please focus on improvement of the standard cms-sw tool . for size/cpu/memory

[mariadalfonso]

+1

[cmsbuild]

This pull request is fully signed and it will be integrated in one of the next master IBs (tests are also fine). This pull request will now be reviewed by the release team before it's merged. @silviodonato, @dpiparo, @qliphy, @perrotta (and backports should be raised in the release meeting by the corresponding L2)

[qliphy]

+1