================= scikit-validate

.. image:: https://img.shields.io/pypi/v/scikit-validate.svg :target: https://pypi.python.org/pypi/scikit-validate

.. image:: https://readthedocs.org/projects/scikit-validate/badge/?version=latest :target: https://scikit-validate.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://badges.gitter.im/FAST-HEP/community.svg :target: https://gitter.im/FAST-HEP/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge :alt: Gitter

• Free software: Apache Software License 2.0
• Documentation: https://scikit-validate.readthedocs.io.
• Issues: https://github.com/FAST-HEP/scikit-validate/issues

Overview

scikit-validate is a validation package for science output developed within F.A.S.T._. This package provides commands for monitoring and comparing analysis outputs, \ computing resource usage (e.g. CPU time/RAM) as well as commands for summarising findings.

It is meant to provide analysis groups or small experiments with some of the fundamental features needed to\ validate (i.e. compare to a reference) the outcomes of their code and to provide easy access to the results.

Features

• Collect metrics in JSON output
  • measure file metrics (e.g. size)
  • measure execution time and memory usage
  • compare to previous executions
• compare ROOT files & plot discrepancies
• create validation reports

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

.. _F.A.S.T.: https://fast-hep.web.cern.ch/fast-hep/public .. Cookiecutter: https://github.com/audreyr/cookiecutter .. audreyr/cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage

Make a new RELEASE

.. code-block:: bash

export RELEASE=X.Y.Z export CHANGELOG_GITHUB_TOKEN= make release