Skip to main content

Python performance monitoring tool using HPC

Project description

CI & HPC · Travis (.org) branch Read the Docs download the PDF Docs PyPI GitHub Coveralls github branch

A simple framework which can monitor the performance and scalability of software packages. The framework presented here combines Continuous Integation & High Performance Computing together with a minimalistic set of Python scripts. The results can be visualised in form of static Jupyter notebook or in an interactive web page.


  • automatically run benchmarks of your project
  • inspect performance and scalability of your project
  • create complex configurations with travis-like syntax build matrix capabilities (YAML format)

How to use ci-hpc?

  1. First install the framework by executing:

    pip3 install --user ci-hpc
  2. Create a configuration (file config.yaml) for your repository. In this cofiguration, you should specify several options.

    • ci-hpc needs to know, which repositories are part of your project. You can specify one or more repositories. Each repository will be cloned and checked out when installing.

    • You also need to tell the ci-hpc how to install your project.
      It can be as simple as

      ./configure; make; make install
      or pip install ./foo/

      But it can be also quite complex, you can even simplify entire process with usage of install file:
      with something like this!sh ( in this case is a shell script, which contains your installation process)

    • Next thing is testing section. Here, ci-hpc needs to know, what benchmarks you want to run under what configuration. You can create complex build matrices so your configuration can be kept simple and transparent.

  3. When you are done with the configuration. You should probably verify, it is working. Assuming the following structure:

    └── hello-world
       └── config.yaml

    Execute ci-hpc with

    cihpc --project hello-world
  4. If everything works, setup a mongoDB server and add collection section (once again file config.yaml):

    • ci-hpc needs to know, what results you want to store. Is it a some json profiler or yaml results? or are the timings save in a xml format? In the ci-hpc there is some general support for the json and yaml formats, but you can write your own artifact module and simply put it in the correct folder.

    • The most of the heavy lifting is already done in a parent class so adding a new collection module should be relatively easy.

  5. Now to display the results, setup a visualization server.

What's new?

  • now supporting multiple repositories within single project
  • speed up testing process by using multiple cores on a computing node
  • easily run ci-hpc on a previous commits by using commit-browser module
  • automatically determine which tests to run based on the previous results
  • webhook support, automatically start ci-chp upon new commit

What's to come?

  • run extra tests when suspecting significant performance change
  • create web visualisation configuration from analyzing records in database

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cihpc-0.2.0.tar.gz (67.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page