Skip to main content
https://github.com/RRZE-HPC/kerncraft/blob/master/doc/logo/logo-lightbg.svg

kerncraft

Loop Kernel Analysis and Performance Modeling Toolkit

This tool allows automatic analysis of loop kernels using the Execution Cache Memory (ECM) model, the Roofline model and actual benchmarks. kerncraft provides a framework to investigate the data reuse and cache requirements by static code analysis. In combination with the Intel IACA tool kerncraft can give a good overview of both in-core and memory bottlenecks and use that data to apply performance models.

For a detailed documentation see publications in doc/.

https://github.com/RRZE-HPC/kerncraft/actions/workflows/test-n-publish.yml/badge.svg https://codecov.io/github/RRZE-HPC/kerncraft/coverage.svg?branch=master

Installation

On most systems with python pip and setuputils installed, just run:

pip install --user kerncraft

for the latest release. In order to get the Intel Achitecture Code Analyzer (IACA), required by the ECM, ECMCPU and RooflineASM performance models, read this and run:

iaca_get --I-accept-the-Intel-What-If-Pre-Release-License-Agreement-and-please-take-my-soul

Additional requirements are:
  • likwid (used in Benchmark model and by likwid_bench_auto)

Usage

  1. Get an example kernel and machine file from the examples directory

wget https://raw.githubusercontent.com/RRZE-HPC/kerncraft/master/examples/machine-files/SandyBridgeEP_E5-2680.yml

wget https://raw.githubusercontent.com/RRZE-HPC/kerncraft/master/examples/kernels/2d-5pt.c

  1. Have a look at the machine file and change it to match your targeted machine (above we downloaded a file for a Sandy Bridge EP machine)

  2. Run kerncraft

kerncraft -p ECM -m SandyBridgeEP_E5-2680.yml 2d-5pt.c -D N 10000 -D M 10000 add -vv for more information on the kernel and ECM model analysis.

Citations

When using Kerncraft for your work, please consider citing the following publication:

Kerncraft: A Tool for Analytic Performance Modeling of Loop Kernels (preprint)

J. Hammer, J. Eitzinger, G. Hager, and G. Wellein: Kerncraft: A Tool for Analytic Performance Modeling of Loop Kernels. In: Tools for High Performance Computing 2016, ISBN 978-3-319-56702-0, 1-22 (2017). Proceedings of IPTW 2016, the 10th International Parallel Tools Workshop, October 4-5, 2016, Stuttgart, Germany. Springer, Cham. DOI: 10.1007/978-3-319-56702-0_1, Preprint: arXiv:1702.04653``

Credits

Implementation: Julian Hammer;
ECM Model (theory): Georg Hager, Holger Stengel, Jan Treibig;
LC generalization: Julian Hammer

License

AGPLv3

Metadata

Release files for kerncraft 0.8.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kerncraft 0.8.18
File Size Uploaded
kerncraft-0.8.18.tar.gz 599.6 kB Details

Release files / kerncraft-0.8.18.tar.gz

Download URL kerncraft-0.8.18.tar.gz
Size 599.6 kB
Tags Source
SHA-256 checksum
How to use checksums
350a6cc44a97f35f357b9a6ff6fc09b60252f79d1374cb22ad4cebfc191359f9
BLAKE2b-256 checksum
How to use checksums
0d39045807ffe54eac8c3e103494c79964c71b14c1f2a2457c7705fb355299fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.8.18 This release

1 release file

0.8.17

1 release file

0.8.15

1 release file

0.8.14

1 release file

0.8.13

1 release file

0.8.12

1 release file

0.8.10

1 release file

0.8.9

1 release file

0.8.8

1 release file

0.8.7

1 release file

0.8.5

1 release file

0.8.4

1 release file

0.8.3

1 release file

0.8.2

1 release file

0.8.0

1 release file

0.7.4

1 release file

0.7.3

1 release file

0.7.2

4 release files

0.7.1

4 release files

0.7.0

4 release files

0.6.9

4 release files

0.6.8

4 release files

0.6.7

1 release file

0.6.6

1 release file

0.6.5

1 release file

0.6.4

1 release file

0.6.3

1 release file

0.6.2

1 release file

0.6.1

1 release file

0.6.0

1 release file

0.5.10

1 release file

0.5.9

1 release file

0.5.8

3 release files

0.5.7

3 release files

0.5.5

3 release files

0.5.4

3 release files

0.5.3

3 release files

0.5.2

3 release files

0.5.1

3 release files

0.5.0

3 release files

0.4.11

3 release files

0.4.9

3 release files

0.4.8

3 release files

0.4.6

3 release files

0.4.5

3 release files

0.4.4

3 release files

0.4.3

3 release files

0.4.2

3 release files

0.4.1

3 release files

0.4.0

3 release files

0.3.6

3 release files

0.3.4

3 release files

0.3.2

3 release files

0.3.1

3 release files

0.3.0

3 release files

0.2.8

3 release files

0.2.7

3 release files

0.2.6

3 release files

0.2.5

3 release files

0.2.4

3 release files

0.2.3

3 release files

0.2.2

3 release files

0.2.1

3 release files

0.2.0

3 release files

0.1

2 release files

0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page