Metadata-Version: 2.0
Name: stressberry
Version: 0.1.2
Summary: stress tests for the Raspberry Pi
Home-page: https://github.com/nschloe/stressberry
Author: Nico Schlömer
Author-email: nico.schloemer@gmail.com
License: License :: OSI Approved :: MIT License
Download-URL: https://pypi.python.org/pypi/stressberry
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Dist: matplotlib
Requires-Dist: psutil
Requires-Dist: pyyaml

stressberry
===========

Stress tests for the Raspberry Pi.

|CircleCI| |awesome| |PyPi Version| |GitHub stars|

.. figure:: https://nschloe.github.io/stressberry/all.png
   :alt: 
   :width: 70.0%

There are a million ways to cool down your Raspberry Pi: Small heat
sinks, specific cases, and some `extreme DIY
solutions <https://youtu.be/WfQMLInuwws>`__. stressberry is a package
for testing the core temperature under different loads, and it produces
nice plots which can easily be compared.

To run stressberry on your computer, simply install it with

::

    [sudo -H] pip3 install -U stressberry

and run it with

::

    stressberry-run out.dat
    stressberry-plot out.dat [-o out.png]

The run lets the CPU idle for a bit, then stresses it with maximum load
for 5 minutes, and lets it cool down afterwards. The entire process
takes 10 minutes. The resulting data is displayed to a screen or, if
specified, written to a PNG file.

If you'd like to submit your own data for display here, feel free to
`open an issue <https://github.com/nschloe/stressberry/issues>`__ and
include the data file, a photograph of your setup, and perhaps some
further information.

The setups
~~~~~~~~~~

A naked Raspberry Pi 3
^^^^^^^^^^^^^^^^^^^^^^

.. figure:: https://nschloe.github.io/stressberry/naked-photo.jpg
   :alt: 
   :width: 30.0%

The Raspberry Pi 3 without fans, heat sinks, or particular cases. The
idle core temperature is about 47°C, under heavy load it reaches 80°C
(at which point the CPU frequency is throttled).

Testing
~~~~~~~

To run the tests, just check out this repository and type

::

    pytest

Distribution
~~~~~~~~~~~~

To create a new release

1. bump the ``__version__`` number,

2. publish to PyPi and GitHub:

   ::

       $ make publish

License
~~~~~~~

stressberry is published under the `MIT
license <https://en.wikipedia.org/wiki/MIT_License>`__.

.. |CircleCI| image:: https://img.shields.io/circleci/project/github/nschloe/stressberry/master.svg
   :target: https://circleci.com/gh/nschloe/stressberry/tree/master
.. |awesome| image:: https://img.shields.io/badge/awesome-yes-brightgreen.svg
   :target: https://img.shields.io/badge/awesome-yes-brightgreen.svg
.. |PyPi Version| image:: https://img.shields.io/pypi/v/stressberry.svg
   :target: https://pypi.python.org/pypi/stressberry
.. |GitHub stars| image:: https://img.shields.io/github/stars/nschloe/stressberry.svg?style=social&label=Stars&maxAge=2592000
   :target: https://github.com/nschloe/stressberry


