Skip to content

Commit 425a9cb

Browse files
zbjornsonzbjornson
committed
deploy: 3198236 
1 parent f4f913d commit 425a9cb

4 files changed

Lines changed: 159 additions & 1 deletion

File tree

‎api_client/index.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -565,6 +565,13 @@
565565
get_statistics
566566
</a>
567567

568+
</li>
569+
570+
<li class="md-nav__item">
571+
<a href="#cellengine.APIClient.import_experiment_resources" class="md-nav__link">
572+
import_experiment_resources
573+
</a>
574+
568575
</li>
569576

570577
<li class="md-nav__item">
@@ -1133,6 +1140,13 @@
11331140
get_statistics
11341141
</a>
11351142

1143+
</li>
1144+
1145+
<li class="md-nav__item">
1146+
<a href="#cellengine.APIClient.import_experiment_resources" class="md-nav__link">
1147+
import_experiment_resources
1148+
</a>
1149+
11361150
</li>
11371151

11381152
<li class="md-nav__item">
@@ -2386,6 +2400,21 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
23862400
<div class="doc doc-object doc-function">
23872401

23882402

2403+
<h3 id="cellengine.APIClient.import_experiment_resources" class="doc doc-heading">
2404+
<code class=" language-python"><span class="n">import_experiment_resources</span><span class="p">(</span><span class="n">experiment_id</span><span class="p">,</span> <span class="n">srcExperimentId</span><span class="p">,</span> <span class="n">what</span><span class="p">,</span> <span class="n">dstPopulationId</span><span class="p">,</span> <span class="n">channelMap</span><span class="p">)</span></code>
2405+
2406+
</h3>
2407+
2408+
2409+
<div class="doc doc-contents ">
2410+
2411+
</div>
2412+
2413+
</div>
2414+
2415+
<div class="doc doc-object doc-function">
2416+
2417+
23892418
<h3 id="cellengine.APIClient.post_compensation" class="doc doc-heading">
23902419
<code class=" language-python"><span class="n">post_compensation</span><span class="p">(</span><span class="n">experiment_id</span><span class="p">,</span> <span class="n">body</span><span class="p">)</span></code>
23912420

‎experiments/index.html‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -747,6 +747,13 @@
747747
get_statistics
748748
</a>
749749

750+
</li>
751+
752+
<li class="md-nav__item">
753+
<a href="#cellengine.resources.experiment.Experiment.import_resources" class="md-nav__link">
754+
import_resources
755+
</a>
756+
750757
</li>
751758

752759
<li class="md-nav__item">
@@ -1357,6 +1364,13 @@
13571364
get_statistics
13581365
</a>
13591366

1367+
</li>
1368+
1369+
<li class="md-nav__item">
1370+
<a href="#cellengine.resources.experiment.Experiment.import_resources" class="md-nav__link">
1371+
import_resources
1372+
</a>
1373+
13601374
</li>
13611375

13621376
<li class="md-nav__item">
@@ -2941,6 +2955,121 @@ <h3 id="cellengine.resources.experiment.Experiment.get_statistics" class="doc do
29412955
<div class="doc doc-object doc-function">
29422956

29432957

2958+
<h3 id="cellengine.resources.experiment.Experiment.import_resources" class="doc doc-heading">
2959+
<code class=" language-python"><span class="n">import_resources</span><span class="p">(</span><span class="n">srcExperimentId</span><span class="p">,</span> <span class="n">what</span><span class="p">,</span> <span class="n">channelMap</span><span class="o">=</span><span class="p">{},</span> <span class="n">dstPopulationId</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
2960+
2961+
</h3>
2962+
2963+
2964+
<div class="doc doc-contents ">
2965+
2966+
<p>Imports resources from another experiment.</p>
2967+
2968+
2969+
<p><span class="doc-section-title">Parameters:</span></p>
2970+
<table>
2971+
<thead>
2972+
<tr>
2973+
<th>Name</th>
2974+
<th>Type</th>
2975+
<th>Description</th>
2976+
<th>Default</th>
2977+
</tr>
2978+
</thead>
2979+
<tbody>
2980+
<tr class="doc-section-item">
2981+
<td>
2982+
<code>srcExperimentId</code>
2983+
</td>
2984+
<td>
2985+
<code>str</code>
2986+
</td>
2987+
<td>
2988+
<div class="doc-md-description">
2989+
<p>The ID of the source experiment.</p>
2990+
</div>
2991+
</td>
2992+
<td>
2993+
<em>required</em>
2994+
</td>
2995+
</tr>
2996+
<tr class="doc-section-item">
2997+
<td>
2998+
<code>what</code>
2999+
</td>
3000+
<td>
3001+
<code><span title="cellengine.resources.experiment.ImportOpts">ImportOpts</span></code>
3002+
</td>
3003+
<td>
3004+
<div class="doc-md-description">
3005+
<p>A dictionary with the following optional keys:
3006+
- populations: Whether to import populations.
3007+
- illustrations: Whether to import illustrations (True = all, False = none),
3008+
or a list of specific illustration IDs to import.
3009+
- compensations: Whether to import compensations (True = all, False = none),
3010+
or a list of specific compensation IDs to import.
3011+
- savedStatisticExports: Whether to import saved statistic exports
3012+
(True = all, False = none), or a list of specific export IDs to import.
3013+
- annotations: Whether to import annotations (True = all, False = none),
3014+
or a list of specific annotation names to import.</p>
3015+
</div>
3016+
</td>
3017+
<td>
3018+
<em>required</em>
3019+
</td>
3020+
</tr>
3021+
<tr class="doc-section-item">
3022+
<td>
3023+
<code>channelMap</code>
3024+
</td>
3025+
<td>
3026+
<code><span title="typing.Dict">Dict</span>[str, str]</code>
3027+
</td>
3028+
<td>
3029+
<div class="doc-md-description">
3030+
<p>A dictionary Object mapping channel
3031+
names from source experiment to destination experiment for
3032+
imported gates. Gates using channels not present in the map or
3033+
with channels set to the value "" will not be imported.
3034+
Populations are only imported if all of their required gates are
3035+
imported (i.e. the entire set of parents must be imported). This
3036+
does not affect compensation import.</p>
3037+
</div>
3038+
</td>
3039+
<td>
3040+
<code>{}</code>
3041+
</td>
3042+
</tr>
3043+
<tr class="doc-section-item">
3044+
<td>
3045+
<code>dstPopulationId</code>
3046+
</td>
3047+
<td>
3048+
<code>str</code>
3049+
</td>
3050+
<td>
3051+
<div class="doc-md-description">
3052+
<p>The ID of the destination parent population.
3053+
If not provided, the root population is used.</p>
3054+
</div>
3055+
</td>
3056+
<td>
3057+
<code>None</code>
3058+
</td>
3059+
</tr>
3060+
</tbody>
3061+
</table>
3062+
<p>Use <code>experiment.gates</code> and similar to access the imported resources.
3063+
<em>Note: If it would be useful for this method to return the imported
3064+
resources, open a GitHub issue letting us know.</em></p>
3065+
3066+
</div>
3067+
3068+
</div>
3069+
3070+
<div class="doc doc-object doc-function">
3071+
3072+
29443073
<h3 id="cellengine.resources.experiment.Experiment.save_revision" class="doc doc-heading">
29453074
<code class=" language-python"><span class="n">save_revision</span><span class="p">(</span><span class="n">description</span><span class="p">)</span></code>
29463075

‎objects.inv‎

27 Bytes
Binary file not shown.

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)