Skip to content

Commit

Permalink
Deployed 10ebf7d with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@sg-s
sg-s committed Dec 5, 2024
1 parent 2cf3247 commit bff1393
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 122 deletions.
2 changes: 1 addition & 1 deletion install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1684,10 +1684,10 @@ <h3 id="compiling-and-serving-the-documentation-for-this-package">Compiling and
<h2 id="supported-python-versions">Supported Python versions<a class="headerlink" href="#supported-python-versions" title="Permanent link">&para;</a></h2>
<p><code>deeporigin</code> is <a href="https://github.com/deeporiginbio/deeporigin-client/actions/workflows/main.yml">tested</a> against the following versions of Python in Ubuntu Linux and Windows:</p>
<ul>
<li>3.9</li>
<li>3.10</li>
<li>3.11</li>
<li>3.12</li>
<li>3.13</li>
</ul>


Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
117 changes: 21 additions & 96 deletions ref/data-hub/high-level-api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1199,15 +1199,6 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.data_hub.api.download_file" class="md-nav__link">
<span class="md-ellipsis">
download_file
</span>
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1710,15 +1701,6 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#src.data_hub.api.download_file" class="md-nav__link">
<span class="md-ellipsis">
download_file
</span>
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -2695,88 +2677,15 @@ <h2 id="src.data_hub.api.download_database" class="doc doc-heading">
<div class="doc doc-object doc-function">


<h2 id="src.data_hub.api.download_file" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">download_file</span>


<a href="#src.data_hub.api.download_file" class="headerlink" title="Permanent link">&para;</a></h2>
<div class="language-python doc-signature highlight"><pre><span></span><code><span class="nf">download_file</span><span class="p">(</span>
<span class="n">file_id</span><span class="p">:</span> <span class="n">str</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">destination</span><span class="p">:</span> <span class="n">str</span> <span class="o">|</span> <span class="n"><span title="pathlib.Path">Path</span></span> <span class="o">=</span> <span class="n"><span title="os.getcwd">getcwd</span></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="n">_stash</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="kc">False</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Download a file to a destination folder (workspace).</p>
<p>Download a file synchronously from Deep Origin
to folder on the local file system.</p>


<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>file_id</code>
</td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>ID of the file on Deep Origin</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code>destination</code>
</td>
<td>
<code>str | <span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Path to the destination folder</p>
</div>
</td>
<td>
<code><span title="os.getcwd">getcwd</span>()</code>
</td>
</tr>
</tbody>
</table>

</div>

</div>

<div class="doc doc-object doc-function">


<h2 id="src.data_hub.api.download_files" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">download_files</span>


<a href="#src.data_hub.api.download_files" class="headerlink" title="Permanent link">&para;</a></h2>
<div class="language-python doc-signature highlight"><pre><span></span><code><span class="nf">download_files</span><span class="p">(</span>
<span class="n">files</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="o">|</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="o">*</span><span class="p">,</span>
<span class="n">files</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">file_ids</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">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">save_to_dir</span><span class="p">:</span> <span class="n"><span title="pathlib.Path">Path</span></span> <span class="o">|</span> <span class="n">str</span> <span class="o">=</span> <span class="n"><span title="pathlib.Path">Path</span></span><span class="p">(</span><span class="s2">&quot;.&quot;</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">client</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
Expand Down Expand Up @@ -2805,11 +2714,11 @@ <h2 id="src.data_hub.api.download_files" class="doc doc-heading">
<code>files</code>
</td>
<td>
<code><span title="typing.Optional">Optional</span>[list | dict]</code>
<code><span title="typing.Optional">Optional</span>[list[dict]]</code>
</td>
<td>
<div class="doc-md-description">
<p>list of files to download. These can be of type <code>types.list_files_response.Data</code> (as returned by api.list_files) or can be a list of strings of file IDs.</p>
<p>list of files to download. These can be a list of file_ids or a list of files as returned by api.list_files</p>
</div>
</td>
<td>
Expand All @@ -2832,6 +2741,22 @@ <h2 id="src.data_hub.api.download_files" class="doc doc-heading">
<code><span title="pathlib.Path">Path</span>(&#39;.&#39;)</code>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code>use_file_names</code>
</td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>If <code>True</code>, refer to files by name rather than ID.</p>
</div>
</td>
<td>
<code>True</code>
</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -3953,7 +3878,7 @@ <h2 id="src.data_hub.api.upload_file" class="doc doc-heading">
<span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">_stash</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="kc">False</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>
<span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

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

0 comments on commit bff1393

Please sign in to comment.