blob: 6d5edc19dc75f8c56fd21879f6336e9cb8df2d3a [file] [edit]
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Build from Source Code &mdash; ITT/JIT APIs Documentation documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
<link rel="canonical" href="https://intel.github.io/ittapi/src/build.html" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Use the ITT/JIT APIs" href="api-support.html" />
<link rel="prev" title="Overview" href="overview.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
ITT/JIT APIs Documentation
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Build from Source Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#technical-requirements">Technical Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-the-itt-jit-apis-source-code">Get the ITT/JIT APIs Source Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-the-itt-jit-apis">Build the ITT/JIT APIs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-support.html">Use the ITT/JIT APIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="ref_collector.html">ITT API Reference Collector</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/intel/ittapi">GitHub Project</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">ITT/JIT APIs Documentation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Build from Source Code</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/src/build.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="build-from-source-code">
<span id="build"></span><h1>Build from Source Code<a class="headerlink" href="#build-from-source-code" title="Link to this heading"></a></h1>
<section id="technical-requirements">
<h2>Technical Requirements<a class="headerlink" href="#technical-requirements" title="Link to this heading"></a></h2>
<p>Before you build the ITT/JIT APIs, make sure you have the following hardware and software tools:</p>
<ul class="simple">
<li><p>Get general development tools, including C/C++ Compiler</p></li>
<li><p>Install <a class="reference external" href="https://python.org">Python</a> 3.6 or later</p></li>
<li><p>Install <a class="reference external" href="https://cmake.org">CMake</a> 3.5 or later</p></li>
<li><p>For a Windows* system, install one of these:</p>
<ul>
<li><p><a class="reference external" href="https://visualstudio.microsoft.com">Microsoft Visual Studio</a> 2015 or later</p></li>
<li><p><a class="reference external" href="https://ninja-build.org">Ninja</a> 1.9 or later</p></li>
</ul>
</li>
<li><p>To enable support for Fortran, install the <a class="reference external" href="https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler-download.html">Intel Fortran Compiler</a></p></li>
</ul>
</section>
<section id="get-the-itt-jit-apis-source-code">
<h2>Get the ITT/JIT APIs Source Code<a class="headerlink" href="#get-the-itt-jit-apis-source-code" title="Link to this heading"></a></h2>
<p>To get the source code for the ITT/JIT APIs, do one of the following:</p>
<ul class="simple">
<li><p>Download it from <a class="reference external" href="https://github.com/intel/ittapi/releases">the latest public Release</a></p></li>
<li><p>Clone the repository:</p></li>
</ul>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">git clone https://github.com/intel/ittapi.git</span>
</pre></div>
</div>
</section>
<section id="build-the-itt-jit-apis">
<h2>Build the ITT/JIT APIs<a class="headerlink" href="#build-the-itt-jit-apis" title="Link to this heading"></a></h2>
<p>To build the ITT/JIT APIs static library, run this command:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">python buildall.py &lt;options&gt;</span>
</pre></div>
</div>
<p>Use these options to configure the build process:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">usage: python buildall.py [-h] [-d] [-c] [-v] [-pt] [-ft] [--force_bits]</span>
<span class="go">optional arguments:</span>
<span class="go"> -h, --help show this help message and exit</span>
<span class="go"> -d, --debug specify debug build configuration (release by default)</span>
<span class="go"> -c, --clean delete any intermediate and output files</span>
<span class="go"> -v, --verbose enable verbose output from build process</span>
<span class="go"> -pt, --ptmark enable anomaly detection support</span>
<span class="go"> -ft, --fortran enable fortran support</span>
<span class="go"> -cpp, --cpp enable C++ wrapper support</span>
<span class="go"> --force_bits specify bit version for the target</span>
<span class="go"> --refcol enable reference collector build</span>
<span class="go"> --vs specify visual studio version (Windows only)</span>
<span class="go"> --cmake_gen specify cmake build generator (Windows only)</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="overview.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="api-support.html" class="btn btn-neutral float-right" title="Use the ITT/JIT APIs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2026 Intel Corporation.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>