CINXE.COM
Welcome to KvikIO’s Python documentation! — kvikio 25.04.00 documentation
<!DOCTYPE html> <html class="writer-html5" data-content_root="./" lang="en"><head> <meta charset="utf-8"><meta content="width=device-width, initial-scale=1" name="viewport"> <meta content="width=device-width, initial-scale=1.0" name="viewport"> <title>Welcome to KvikIO’s Python documentation! — kvikio 25.04.00 documentation</title> <link href="_static/pygments.css?v=b86133f3" rel="stylesheet" type="text/css"> <link href="_static/css/theme.css?v=e59714d7" rel="stylesheet" type="text/css"> <link href="https://docs.rapids.ai/assets/css/custom.css" rel="stylesheet" type="text/css"> <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=07caf672"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script defer="defer" src="https://docs.rapids.ai/assets/js/custom.js"></script> <script src="_static/js/theme.js"></script> <link href="genindex/" rel="index" title="Index"> <link href="search/" rel="search" title="Search"> <link href="install/" rel="next" title="Installation"> <script id="rapids-selector-pixel-src" src="https://assets.adobedtm.com/5d4962a43b79/814eb6e9b4e1/launch-4bc07f1e0b0b.min.js"></script><link href="/assets/css/custom.css" id="rapids-selector-css" rel="stylesheet"></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav class="wy-nav-side" data-toggle="wy-nav-shift"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"><div id="rapids-jtd-container"><div class="rapids-home-container"><a class="rapids-home-container__home-btn" href="/api">Home</a></div><div class="rapids-selector__container rapids-selector--hidden"><div class="rapids-selector__selected">kvikio</div><div class="rapids-selector__menu"><a class="rapids-selector__menu-item" href="/api/cucim/stable">cucim</a><a class="rapids-selector__menu-item" href="/api/cudf-java/stable">cudf-java</a><a class="rapids-selector__menu-item" href="/api/cudf/stable/">cudf</a><a class="rapids-selector__menu-item" href="/api/cugraph/stable">cugraph</a><a class="rapids-selector__menu-item" href="/api/cuml/stable">cuml</a><a class="rapids-selector__menu-item" href="/api/cuproj/stable">cuproj</a><a class="rapids-selector__menu-item" href="/api/cuspatial/stable">cuspatial</a><a class="rapids-selector__menu-item" href="/api/cuvs/stable">cuvs</a><a class="rapids-selector__menu-item" href="/api/cuxfilter/stable">cuxfilter</a><a class="rapids-selector__menu-item" href="/api/dask-cuda/stable">dask-cuda</a><a class="rapids-selector__menu-item" href="/api/dask-cudf/stable">dask-cudf</a><a class="rapids-selector__menu-item rapids-selector__menu-item--selected" href="/api/kvikio/stable">kvikio</a><a class="rapids-selector__menu-item" href="/api/libcudf/stable/namespacecudf/">libcudf</a><a class="rapids-selector__menu-item" href="/api/libcuml/stable">libcuml</a><a class="rapids-selector__menu-item" href="/api/libcuproj/stable">libcuproj</a><a class="rapids-selector__menu-item" href="/api/libcuspatial/stable">libcuspatial</a><a class="rapids-selector__menu-item" href="/api/libkvikio/stable">libkvikio</a><a class="rapids-selector__menu-item" href="/api/librmm/stable">librmm</a><a class="rapids-selector__menu-item" href="/api/libucxx/stable">libucxx</a><a class="rapids-selector__menu-item" href="/api/raft/stable">raft</a><a class="rapids-selector__menu-item" href="/api/rapids-cmake/stable">rapids-cmake</a><a class="rapids-selector__menu-item" href="/api/rmm/stable">rmm</a></div></div><div class="rapids-selector__container rapids-selector--hidden"><div class="rapids-selector__selected">nightly (25.04)</div><div class="rapids-selector__menu"><a class="rapids-selector__menu-item rapids-selector__menu-item--selected" href="/api/kvikio/nightly">nightly (25.04)</a><a class="rapids-selector__menu-item" href="/api/kvikio/stable">stable (25.02)</a><a class="rapids-selector__menu-item" href="/api/kvikio/legacy">legacy (24.12)</a></div></div></div> <div role="search"> <form action="search/" class="wy-form" id="rtd-search-form" method="get"> <input aria-label="Search docs" name="q" placeholder="Search docs" type="text"> <input name="check_keywords" type="hidden" value="yes"> <input name="area" type="hidden" value="default"> </form> </div> </div><div aria-label="Navigation menu" class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation"> <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="install/">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="quickstart/">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="zarr/">Zarr</a></li> <li class="toctree-l1"><a class="reference internal" href="remote_file/">Remote File</a></li> <li class="toctree-l1"><a class="reference internal" href="runtime_settings/">Runtime Settings</a></li> <li class="toctree-l1"><a class="reference internal" href="api/">API</a></li> <li class="toctree-l1"><a class="reference internal" href="genindex/">Index</a></li> </ul> </div> </div> </nav> <section class="wy-nav-content-wrap" data-toggle="wy-nav-shift"><nav aria-label="Mobile navigation menu" class="wy-nav-top"> <i class="fa fa-bars" data-toggle="wy-nav-top"></i> <a href="#">kvikio</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div aria-label="Page navigation" role="navigation"> <ul class="wy-breadcrumbs"> <li><a aria-label="Home" class="icon icon-home" href="#"></a></li> <li class="breadcrumb-item active">Welcome to KvikIO’s Python documentation!</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr> </div> <div class="document" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"> <div itemprop="articleBody"> <section id="welcome-to-kvikio-s-python-documentation"> <h1>Welcome to KvikIO’s Python documentation!<a class="headerlink" href="#welcome-to-kvikio-s-python-documentation" title="Link to this heading"></a></h1> <p>KvikIO is a Python and C++ library for high performance file IO. It provides C++ and Python bindings to <a class="reference external" href="https://docs.nvidia.com/gpudirect-storage/api-reference-guide/index.html">cuFile</a>, which enables <a class="reference external" href="https://developer.nvidia.com/blog/gpudirect-storage/">GPUDirect Storage</a> (GDS). KvikIO also works efficiently when GDS isn’t available and can read/write both host and device data seamlessly.</p> <p>KvikIO is a part of the <a class="reference external" href="https://rapids.ai/">RAPIDS</a> suite of open-source software libraries for GPU-accelerated data science.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>This is the documentation for the Python library. For the C++ documentation, see under <a class="reference external" href="https://docs.rapids.ai/api/libkvikio/nightly/">libkvikio</a>.</p> </div> <section id="contents"> <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading"></a></h2> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="install/">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="quickstart/">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="zarr/">Zarr</a></li> <li class="toctree-l1"><a class="reference internal" href="remote_file/">Remote File</a></li> <li class="toctree-l1"><a class="reference internal" href="runtime_settings/">Runtime Settings</a></li> <li class="toctree-l1"><a class="reference internal" href="api/">API</a></li> <li class="toctree-l1"><a class="reference internal" href="genindex/">Index</a></li> </ul> </div> </section> </section> </div> </div> <footer><div aria-label="Footer" class="rst-footer-buttons" role="navigation"> <a accesskey="n" class="btn btn-neutral float-right" href="install/" rel="next" title="Installation">Next <span aria-hidden="true" class="fa fa-arrow-circle-right"></span></a> </div> <hr> <div role="contentinfo"> <p>© Copyright 2023, NVIDIA.</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> <script defer id="rapids-selector-js" src="/assets/js/custom.js"></script><script id="rapids-selector-pixel-invocation" type="text/javascript">_satellite.pageBottom();</script></body></html>