Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.25 KB

README.md

File metadata and controls

55 lines (38 loc) · 2.25 KB
Raw

perprof-py

Tests Lint PyPI

A Python module for performance profiling (as described by Dolan and Moré) with TikZ and matplotlib output.

Reference

When using this software for publications, please cite the paper below, which describes this project:

Siqueira, A. S., Costa da Silva, R. G. and Santos, L.-R., (2016). Perprof-py: A Python Package for Performance Profile of Mathematical Optimization Software. Journal of Open Research Software. 4(1), p.e12. DOI: http://doi.org/10.5334/jors.81.

License

Copyright (C) 2013-2023 Abel Soares Siqueira, Raniere Gaia Costa da Silva, Luiz Rafael dos Santos. Licensed under the GNU GPL v3.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Install

python -m pip install perprof-py

For more details, see the documentation.

How to use

perprof-py FILES BACKEND

For more details on the FILES format and the available backends, see the documentation.

Getting Help

If you didn't find something at the documentation, want to report a bug, or request a new feature, please open an issue.