Deploying to gh-pages from @ f2ecbab 🚀

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a8922987275da5bda11c537351df3c11
+config: cf0f4d2a2ba29fbebaa19217f2b3d33a
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/index.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>Overview: module code - hdf5array 0.3.0 documentation</title>
+        <title>Overview: module code - hdf5array 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -122,7 +122,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">hdf5array 0.3.0 documentation</div></a>
+      <a href="../index.html"><div class="brand">hdf5array 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -145,7 +145,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">hdf5array 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">hdf5array 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -230,7 +230,7 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../_static/documentation_options.js?v=4621528c"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>

_sources/authors.md.txt

@@ -2,4 +2,3 @@
 
 * Aaron Lun [infinite.monkeys.with.keyboards@gmail.com](mailto:infinite.monkeys.with.keyboards@gmail.com)
 * Jayaram Kancherla [jayaram.kancherla@gmail.com](mailto:jayaram.kancherla@gmail.com)
-

_sources/changelog.md.txt

@@ -11,5 +11,3 @@
 ## Version 0.0.1
 
 - initial classes for H5 backed matrices
-
-

_sources/readme.md.txt

@@ -100,9 +100,9 @@ The constructor will not do any auto-detection so we need to provide this inform
 ```python
 import hdf5array
 arr = hdf5array.Hdf5CompressedSparseMatrix(
-    "sparse_whee.h5", 
-    "sparse_blah", 
-    shape=(100, 200), 
+    "sparse_whee.h5",
+    "sparse_blah",
+    shape=(100, 200),
     by_column=True
 )
 ## <100 x 200> sparse Hdf5CompressedSparseMatrix object of type 'float64'

_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.3.0',
+    VERSION: '0.3.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

api/hdf5array.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="prev" title="hdf5array" href="modules.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>hdf5array package - hdf5array 0.3.0 documentation</title>
+        <title>hdf5array package - hdf5array 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">hdf5array 0.3.0 documentation</div></a>
+      <a href="../index.html"><div class="brand">hdf5array 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">hdf5array 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">hdf5array 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -208,9 +208,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dt class="sig sig-object py" id="hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrix">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hdf5array.Hdf5CompressedSparseMatrixSeed.</span></span><span class="sig-name descname"><span class="pre">Hdf5CompressedSparseMatrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_column</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/hdf5array/Hdf5CompressedSparseMatrixSeed.html#Hdf5CompressedSparseMatrix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrix" title="Link to this definition">#</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://biocpy.github.io/DelayedArray/api/delayedarray.html#delayedarray.DelayedArray.DelayedArray" title="(in DelayedArray v0.5.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">DelayedArray</span></code></a></p>
-<p>Compressed sparse matrix in a HDF5 file as a <code class="docutils literal notranslate"><span class="pre">DelayedArray</span></code>. This
-subclass allows developers to implement custom methods for HDF5-backed
-sparse matrices.</p>
+<p>Compressed sparse matrix in a HDF5 file as a <code class="docutils literal notranslate"><span class="pre">DelayedArray</span></code>.</p>
 <dl class="py property">
 <dt class="sig sig-object py" id="hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrix.by_column">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">by_column</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3.9/library/functions.html#bool" title="(in Python v3.9)"><span class="pre">bool</span></a></em><a class="headerlink" href="#hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrix.by_column" title="Link to this definition">#</a></dt>
@@ -267,8 +265,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dt class="sig sig-object py" id="hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrixSeed">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hdf5array.Hdf5CompressedSparseMatrixSeed.</span></span><span class="sig-name descname"><span class="pre">Hdf5CompressedSparseMatrixSeed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_column</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index_dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indices_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indptr_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/hdf5array/Hdf5CompressedSparseMatrixSeed.html#Hdf5CompressedSparseMatrixSeed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrixSeed" title="Link to this definition">#</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.9/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
-<p>Compressed sparse matrix stored in a HDF5 file, represented as a
-<code class="docutils literal notranslate"><span class="pre">DelayedArray</span></code> seed. This assumes that there are three datasets; <code class="docutils literal notranslate"><span class="pre">data</span></code>
+<p>Compressed sparse matrix stored in a HDF5 file, represented as a <code class="docutils literal notranslate"><span class="pre">DelayedArray</span></code> seed.</p>
+<p>This assumes that there are three datasets; <code class="docutils literal notranslate"><span class="pre">data</span></code>
 containing the data values, <code class="docutils literal notranslate"><span class="pre">indices</span></code> containing the indices, and
 <code class="docutils literal notranslate"><span class="pre">indptr</span></code> containing the pointers to the start of every row/column.</p>
 <dl class="py property">
@@ -302,7 +300,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py property">
 <dt class="sig sig-object py" id="hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrixSeed.index_dtype">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">index_dtype</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">&lt;property</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7ff692f85950&gt;</span></em><a class="headerlink" href="#hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrixSeed.index_dtype" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">index_dtype</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">&lt;property</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f2a329886d0&gt;</span></em><a class="headerlink" href="#hdf5array.Hdf5CompressedSparseMatrixSeed.Hdf5CompressedSparseMatrixSeed.index_dtype" title="Link to this definition">#</a></dt>
 <dd><p>Returns:
 NumPy type of the indices in this matrix.</p>
 </dd></dl>
@@ -341,8 +339,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dt class="sig sig-object py" id="hdf5array.Hdf5CompressedSparseMatrixSeed.chunk_grid_Hdf5CompressedSparseMatrixSeed">
 <span class="sig-prename descclassname"><span class="pre">hdf5array.Hdf5CompressedSparseMatrixSeed.</span></span><span class="sig-name descname"><span class="pre">chunk_grid_Hdf5CompressedSparseMatrixSeed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/hdf5array/Hdf5CompressedSparseMatrixSeed.html#chunk_grid_Hdf5CompressedSparseMatrixSeed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hdf5array.Hdf5CompressedSparseMatrixSeed.chunk_grid_Hdf5CompressedSparseMatrixSeed" title="Link to this definition">#</a></dt>
 <dd><p>See <code class="xref py py-meth docutils literal notranslate"><span class="pre">chunk_grid()</span></code>.</p>
-<p>The cost factor is set to 20 to reflect the computational work involved in
-extracting data from disk.</p>
+<p>The cost factor is set to 20 to reflect the computational work involved in extracting data from disk.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -408,8 +405,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dt class="sig sig-object py" id="hdf5array.Hdf5DenseArraySeed.Hdf5DenseArray">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hdf5array.Hdf5DenseArraySeed.</span></span><span class="sig-name descname"><span class="pre">Hdf5DenseArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/hdf5array/Hdf5DenseArraySeed.html#Hdf5DenseArray"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hdf5array.Hdf5DenseArraySeed.Hdf5DenseArray" title="Link to this definition">#</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://biocpy.github.io/DelayedArray/api/delayedarray.html#delayedarray.DelayedArray.DelayedArray" title="(in DelayedArray v0.5.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">DelayedArray</span></code></a></p>
-<p>HDF5-backed dataset as a <code class="docutils literal notranslate"><span class="pre">DelayedArray</span></code> dense array. This subclass
-allows developers to implement custom methods for HDF5-backed arrays.</p>
+<p>HDF5-backed dataset as a <code class="docutils literal notranslate"><span class="pre">DelayedArray</span></code> dense array.</p>
+<p>This subclass allows developers to implement custom methods for HDF5-backed arrays.</p>
 <dl class="py property">
 <dt class="sig sig-object py" id="hdf5array.Hdf5DenseArraySeed.Hdf5DenseArray.name">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3.9/library/stdtypes.html#str" title="(in Python v3.9)"><span class="pre">str</span></a></em><a class="headerlink" href="#hdf5array.Hdf5DenseArraySeed.Hdf5DenseArray.name" title="Link to this definition">#</a></dt>
@@ -465,8 +462,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dt class="sig sig-object py" id="hdf5array.Hdf5DenseArraySeed.chunk_grid_Hdf5DenseArraySeed">
 <span class="sig-prename descclassname"><span class="pre">hdf5array.Hdf5DenseArraySeed.</span></span><span class="sig-name descname"><span class="pre">chunk_grid_Hdf5DenseArraySeed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/hdf5array/Hdf5DenseArraySeed.html#chunk_grid_Hdf5DenseArraySeed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hdf5array.Hdf5DenseArraySeed.chunk_grid_Hdf5DenseArraySeed" title="Link to this definition">#</a></dt>
 <dd><p>See <code class="xref py py-meth docutils literal notranslate"><span class="pre">chunk_grid()</span></code>.</p>
-<p>The cost factor is set to 20 to reflect the computational work involved in
-extracting data from disk.</p>
+<p>The cost factor is set to 20 to reflect the computational work involved in extracting data from disk.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -615,7 +611,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../_static/documentation_options.js?v=4621528c"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>

api/modules.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="hdf5array package" href="hdf5array.html" /><link rel="prev" title="Changelog" href="../changelog.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>hdf5array - hdf5array 0.3.0 documentation</title>
+        <title>hdf5array - hdf5array 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">hdf5array 0.3.0 documentation</div></a>
+      <a href="../index.html"><div class="brand">hdf5array 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">hdf5array 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">hdf5array 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -310,7 +310,7 @@ <h1>hdf5array<a class="headerlink" href="#hdf5array" title="Link to this heading
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../_static/documentation_options.js?v=4621528c"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>