Skip to content

Commit

Permalink
Deployed a553aa9 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@sg-s
sg-s committed Oct 24, 2024
1 parent f6d64f2 commit 4cee630
Show file tree
Hide file tree
Showing 8 changed files with 142 additions and 90 deletions.
1 change: 0 additions & 1 deletion CNAME
View file

This file was deleted.

109 changes: 109 additions & 0 deletions changelog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1327,6 +1327,48 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#deeporigin-v240" class="md-nav__link">
<span class="md-ellipsis">
deeporigin v2.4.0
</span>
</a>

<nav class="md-nav" aria-label="deeporigin v2.4.0">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#bugfixes" class="md-nav__link">
<span class="md-ellipsis">
Bugfixes
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#new-features" class="md-nav__link">
<span class="md-ellipsis">
New features
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#miscellaneous" class="md-nav__link">
<span class="md-ellipsis">
Miscellaneous
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#deeporigin-v221" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -1410,6 +1452,48 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#deeporigin-v240" class="md-nav__link">
<span class="md-ellipsis">
deeporigin v2.4.0
</span>
</a>

<nav class="md-nav" aria-label="deeporigin v2.4.0">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#bugfixes" class="md-nav__link">
<span class="md-ellipsis">
Bugfixes
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#new-features" class="md-nav__link">
<span class="md-ellipsis">
New features
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#miscellaneous" class="md-nav__link">
<span class="md-ellipsis">
Miscellaneous
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#deeporigin-v221" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -1456,6 +1540,31 @@


<h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">&para;</a></h1>
<h2 id="deeporigin-v240"><code>deeporigin v2.4.0</code><a class="headerlink" href="#deeporigin-v240" title="Permanent link">&para;</a></h2>
<h3 id="bugfixes">Bugfixes<a class="headerlink" href="#bugfixes" title="Permanent link">&para;</a></h3>
<ul>
<li>fixed a bug in how tokens were refreshed</li>
<li>fixed a bug in CLI config use</li>
</ul>
<h3 id="new-features">New features<a class="headerlink" href="#new-features" title="Permanent link">&para;</a></h3>
<ul>
<li>added the ability to download files in parallel</li>
<li>added ability to upload files with file hashes </li>
<li>added the ability to decode user tokens</li>
<li>support for a async client for the Deep Origin Data Hub API</li>
<li>reference IDs now tracked in dataframes </li>
<li>dataframes now support expressions and users </li>
<li>dataframe slicing now restricts addition of new rows to slice</li>
<li>dataframe updates more atomic: a single cell change only triggers updating that cell</li>
<li>ability to delete terminated workstations </li>
<li>package wide ability to check for latest versions on PyPI</li>
</ul>
<h3 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permanent link">&para;</a></h3>
<ul>
<li>testing now includes python 3.13</li>
<li>Data Hub API route now set to <code>datahub-api/api/</code></li>
<li>improved test coverage</li>
</ul>
<h2 id="deeporigin-v221"><code>deeporigin v2.2.1</code><a class="headerlink" href="#deeporigin-v221" title="Permanent link">&para;</a></h2>
<ul>
<li>added the ability to interact with the platform, including<ul>
Expand Down
2 changes: 1 addition & 1 deletion configure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1499,7 +1499,7 @@ <h2 id="view-configuration">View configuration<a class="headerlink" href="#view-
│ bench_id │ average-possum-3x3 │
│ env │ us-west-1 │
│ api_endpoint │ https://os.prod.deeporigin.io/api │
│ nucleus_api_route │ nucleus-api/api/ │
│ nucleus_api_route │ datahub-api/api/ │
│ auth_domain │ https://formicbio-dev.us.auth0.com │
│ auth_device_code_endpoint │ oauth/device/code/ │
│ auth_token_endpoint │ oauth/token/ │
Expand Down
8 changes: 7 additions & 1 deletion ref/data-hub/high-level-api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3535,6 +3535,7 @@ <h2 id="src.data_hub.api.set_data_in_cells" class="doc doc-heading">
<span class="n">row_ids</span><span class="p">:</span> <span class="n">list</span><span class="p">[</span><span class="n">str</span><span class="p">],</span>
<span class="n">column_id</span><span class="p">:</span> <span class="n">str</span><span class="p">,</span>
<span class="n">database_id</span><span class="p">:</span> <span class="n">str</span><span class="p">,</span>
<span class="n">columns</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n">list</span><span class="p">[</span><span class="n">dict</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="kc">None</span>
<span class="p">)</span>
</code></pre></div>
Expand All @@ -3555,7 +3556,12 @@ <h2 id="src.data_hub.api.upload_file" class="doc doc-heading">


<a href="#src.data_hub.api.upload_file" class="headerlink" title="Permanent link">&para;</a></h2>
<div class="language-python doc-signature highlight"><pre><span></span><code><span class="nf">upload_file</span><span class="p">(</span><span class="n">file_path</span><span class="p">:</span> <span class="n">str</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
<div class="language-python doc-signature highlight"><pre><span></span><code><span class="nf">upload_file</span><span class="p">(</span>
<span class="n">file_path</span><span class="p">:</span> <span class="n">str</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">compute_hash</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="kc">True</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down
64 changes: 1 addition & 63 deletions ref/data-hub/types.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1736,7 +1736,6 @@ <h3 id="src.data_hub.dataframe.DataFrame.from_deeporigin" class="doc doc-heading
<span class="o">*</span><span class="p">,</span>
<span class="n">use_file_names</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<span class="n">reference_format</span><span class="p">:</span> <span class="n"><span title="deeporigin.utils.constants.IDFormat">IDFormat</span></span> <span class="o">=</span> <span class="s2">&quot;human-id&quot;</span><span class="p">,</span>
<span class="n">return_type</span><span class="p">:</span> <span class="n"><span title="deeporigin.utils.constants.DatabaseReturnType">DatabaseReturnType</span></span> <span class="o">=</span> <span class="s2">&quot;dataframe&quot;</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="kc">None</span>
<span class="p">)</span>
</code></pre></div>
Expand Down Expand Up @@ -1799,20 +1798,6 @@ <h3 id="src.data_hub.dataframe.DataFrame.from_deeporigin" class="doc doc-heading
<code>&#39;human-id&#39;</code>
</td>
</tr>
<tr class="doc-section-item">
<td><code>return_type</code></td>
<td>
<code><span title="deeporigin.utils.constants.DatabaseReturnType">DatabaseReturnType</span></code>
</td>
<td>
<div class="doc-md-description">
<p>The type of return value. Defaults to "dataframe".</p>
</div>
</td>
<td>
<code>&#39;dataframe&#39;</code>
</td>
</tr>
</tbody>
</table>

Expand All @@ -1828,11 +1813,7 @@ <h3 id="src.data_hub.dataframe.DataFrame.to_deeporigin" class="doc doc-heading">


<a href="#src.data_hub.dataframe.DataFrame.to_deeporigin" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span class="nf">to_deeporigin</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">columns</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n">list</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">rows</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n">list</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="p">)</span>
<div class="language-python doc-signature highlight"><pre><span></span><code><span class="nf">to_deeporigin</span><span class="p">()</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -1843,49 +1824,6 @@ <h3 id="src.data_hub.dataframe.DataFrame.to_deeporigin" class="doc doc-heading">
<p>To automatically save changes to local DataFrames to Deep Origin databases, set the <code>auto_sync</code> attribute of the dataframe <code>True</code>.</p>
</div>


<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>columns</code></td>
<td>
<code>list</code>
</td>
<td>
<div class="doc-md-description">
<p>The columns of the dataframe to update. When None, all modified columns are updated.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr class="doc-section-item">
<td><code>rows</code></td>
<td>
<code>list</code>
</td>
<td>
<div class="doc-md-description">
<p>The rows to update. Defaults to None. When None, all rows in the relevant columns are updated.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
</tbody>
</table>

</div>

</div>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

46 changes: 23 additions & 23 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,117 +2,117 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/index.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/changelog.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/configure.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/install.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/compute-hub/index.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/data-hub/index.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/data-hub/dataframes.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/auth.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/compute-hub/variables.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/compute-hub/workstation-info.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/data-hub/create.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/data-hub/delete.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/data-hub/download-files.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/data-hub/list-data.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/data-hub/upload-files.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/data-hub/view-data.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/data-hub/write-data.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/platform/user-info.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/how-to/platform/workstation-info.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/platform/index.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/ref/data-hub/high-level-api.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/ref/data-hub/low-level-api.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://deeporiginbio.github.io/deeporigin-client/ref/data-hub/types.html</loc>
<lastmod>2024-10-08</lastmod>
<lastmod>2024-10-24</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 4cee630

Please sign in to comment.