Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Oct 21, 2024
1 parent 0ae7d62 commit eafaf95
Show file tree
Hide file tree
Showing 32 changed files with 4,982 additions and 2,569 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
51fb6b13
80a288e7
360 changes: 234 additions & 126 deletions reference/array.html

Large diffs are not rendered by default.

244 changes: 158 additions & 86 deletions reference/asset.html

Large diffs are not rendered by default.

83 changes: 66 additions & 17 deletions reference/bioimg.exportation.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,40 @@
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
vertical-align: middle;
}
/* CSS for syntax highlighting */
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
}
pre.numberSource { margin-left: 3em; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
</style>


Expand Down Expand Up @@ -430,15 +464,30 @@ <h2 class="anchored" data-anchor-id="functions">Functions</h2>
</table>
<section id="tiledb.cloud.bioimg.exportation.export" class="level3">
<h3 class="anchored" data-anchor-id="tiledb.cloud.bioimg.exportation.export">export</h3>
<p><code>cloud.bioimg.exportation.export(source, output, *args, access_credentials_name, config=None, taskgraph_name=None, num_batches=None, resources=None, compute=True, mode=Mode.BATCH, namespace=None, verbose=False, output_ext='tiff', **kwargs)</code></p>
<div class="sourceCode" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>cloud.bioimg.exportation.export(</span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> source</span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> output</span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="op">*</span>args</span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> access_credentials_name</span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> config<span class="op">=</span><span class="va">None</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> taskgraph_name<span class="op">=</span><span class="va">None</span></span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a> num_batches<span class="op">=</span><span class="va">None</span></span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a> resources<span class="op">=</span><span class="va">None</span></span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a> compute<span class="op">=</span><span class="va">True</span></span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a> mode<span class="op">=</span>Mode.BATCH</span>
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a> namespace<span class="op">=</span><span class="va">None</span></span>
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a> verbose<span class="op">=</span><span class="va">False</span></span>
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a> output_ext<span class="op">=</span><span class="st">'tiff'</span></span>
<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a> <span class="op">**</span>kwargs</span>
<span id="cb1-16"><a href="#cb1-16" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>The function exports microscopy images from TileDB arrays</p>
<section id="parameters" class="level4">
<h4 class="anchored" data-anchor-id="parameters">Parameters</h4>
<section id="parameters" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters">Parameters</h4>
<table class="caption-top table">
<colgroup>
<col style="width: 13%">
<col style="width: 17%">
<col style="width: 61%">
<col style="width: 62%">
<col style="width: 7%">
</colgroup>
<thead>
Expand All @@ -451,79 +500,79 @@ <h4 class="anchored" data-anchor-id="parameters">Parameters</h4>
</thead>
<tbody>
<tr class="odd">
<td><code>source</code></td>
<td>source</td>
<td>Union[Sequence[str], str]</td>
<td>uri / iterable of uris of input files If the uri points to a directory of files make sure it ends with a trailing ‘/’</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td><code>output</code></td>
<td>output</td>
<td>Union[Sequence[str], str]</td>
<td>uri / iterable of uris of input files. If the uri points to a directory of files make sure it ends with a trailing ‘/’</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td><code>config</code></td>
<td>config</td>
<td>Optional[Mapping[str, Any]]</td>
<td>dict configuration to pass credentials of the destination</td>
<td><code>None</code></td>
</tr>
<tr class="even">
<td><code>taskgraph_name</code></td>
<td>taskgraph_name</td>
<td>Optional[str]</td>
<td>Optional name for taskgraph, defaults to None</td>
<td><code>None</code></td>
</tr>
<tr class="odd">
<td><code>num_batches</code></td>
<td>num_batches</td>
<td>Optional[int]</td>
<td>Number of graph nodes to spawn. Performs it sequentially if default, defaults to 1</td>
<td><code>None</code></td>
</tr>
<tr class="even">
<td><code>threads</code></td>
<td>threads</td>
<td></td>
<td>Number of threads for node side multiprocessing, defaults to 8</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td><code>resources</code></td>
<td>resources</td>
<td>Optional[Mapping[str, Any]]</td>
<td>configuration for node specs e.g.&nbsp;{“cpu”: “8”, “memory”: “4Gi”}, defaults to None</td>
<td><code>None</code></td>
</tr>
<tr class="even">
<td><code>compute</code></td>
<td>compute</td>
<td>bool</td>
<td>When True the DAG returned will be computed inside the function otherwise DAG will only be returned.</td>
<td><code>True</code></td>
</tr>
<tr class="odd">
<td><code>mode</code></td>
<td>mode</td>
<td>Optional[Mode]</td>
<td>By default runs Mode.Batch</td>
<td><code>Mode.BATCH</code></td>
</tr>
<tr class="even">
<td><code>namespace</code></td>
<td>namespace</td>
<td>Optional[str]</td>
<td>The namespace where the DAG will run</td>
<td><code>None</code></td>
</tr>
<tr class="odd">
<td><code>verbose</code></td>
<td>verbose</td>
<td>bool</td>
<td>verbose logging, defaults to False</td>
<td><code>False</code></td>
</tr>
<tr class="even">
<td><code>access_credentials_name</code></td>
<td>access_credentials_name</td>
<td>str</td>
<td>Access Credentials Name (ACN) registered in TileDB Cloud (ARN type)</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td><code>output_ext</code></td>
<td>output_ext</td>
<td>str</td>
<td>extension for the output images in tiledb</td>
<td><code>'tiff'</code></td>
Expand Down
Loading

0 comments on commit eafaf95

Please sign in to comment.