Add information about how to create the profiling call graph

ImperialCollegeLondon / pyrealm

Development of the pyrealm package, providing an integrated toolbox for modelling plant productivity, growth and demography using Python.

https://pyrealm.readthedocs.io/

MIT License

19 stars 8 forks source link

Add information about how to create the profiling call graph #145

Closed MarionBWeinzierl closed 9 months ago

MarionBWeinzierl commented 9 months ago

The information about profiling in CONTRIBUTING.md is missing the info how to create the call graph from #81 , see https://github.com/ImperialCollegeLondon/pyrealm/issues/81#issuecomment-1683632703 . The same comment also provides the command for the coverage report. Note that the command needs graphviz installed, which includes dot, which is the tool to convert the files to svg.

This information should be added to CONTRIBUTING.md.

tztsai commented 9 months ago

Windows developers will need to manually install graphviz to generate the call graph. For example from releases at https://gitlab.com/graphviz/graphviz/-/releases.