Skip to content

Commit

Permalink
deploy: 38d6e09
Browse files Browse the repository at this point in the history
  • Loading branch information
@julianaklulo
julianaklulo committed Nov 28, 2023
1 parent 99fc34e commit 033b5f9
Show file tree
Hide file tree
Showing 4 changed files with 172 additions and 1 deletion.
Binary file modified objects.inv
View file
Binary file not shown.
171 changes: 171 additions & 0 deletions reference/agent/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1148,6 +1148,27 @@
get_job_parameters()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.get_job_script_file" class="md-nav__link">
get_job_script_file()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.process_supporting_files" class="md-nav__link">
process_supporting_files()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.retrieve_submission_file" class="md-nav__link">
retrieve_submission_file()
</a>

</li>

<li class="md-nav__item">
Expand All @@ -1169,6 +1190,13 @@
unpack_error_from_slurm_response()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.write_submission_file" class="md-nav__link">
write_submission_file()
</a>

</li>

</ul>
Expand Down Expand Up @@ -1861,6 +1889,27 @@
get_job_parameters()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.get_job_script_file" class="md-nav__link">
get_job_script_file()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.process_supporting_files" class="md-nav__link">
process_supporting_files()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.retrieve_submission_file" class="md-nav__link">
retrieve_submission_file()
</a>

</li>

<li class="md-nav__item">
Expand All @@ -1882,6 +1931,13 @@
unpack_error_from_slurm_response()
</a>

</li>

<li class="md-nav__item">
<a href="#jobbergate_agent.jobbergate.submit.write_submission_file" class="md-nav__link">
write_submission_file()
</a>

</li>

</ul>
Expand Down Expand Up @@ -3372,6 +3428,93 @@ <h6 id="jobbergate_agent.jobbergate.submit.get_job_parameters" class="doc doc-he



<h6 id="jobbergate_agent.jobbergate.submit.get_job_script_file" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_job_script_file</span>


<span class="doc doc-labels">
<small class="doc doc-label doc-label-async"><code>async</code></small>
</span>

</h6>
<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">get_job_script_file</span><span class="p">(</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">pending_job_submission</span><span class="p">:</span> <span class="n">PendingJobSubmission</span><span class="p">,</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">submit_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span>
</span></code></pre></div>

<div class="doc doc-contents ">

<p>Get the job script file from the backend.</p>
<p>Write the job script file to the submit_dir if WRITE_SUBMISSION_FILES is set to True.</p>

</div>

</div>


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




<h6 id="jobbergate_agent.jobbergate.submit.process_supporting_files" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">process_supporting_files</span>


<span class="doc doc-labels">
<small class="doc doc-label doc-label-async"><code>async</code></small>
</span>

</h6>
<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">process_supporting_files</span><span class="p">(</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">pending_job_submission</span><span class="p">:</span> <span class="n">PendingJobSubmission</span><span class="p">,</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">submit_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
</span></code></pre></div>

<div class="doc doc-contents ">

<p>Process the submission support files.</p>
<p>Write the support files to the submit_dir if WRITE_SUBMISSION_FILES is set to True.
Reject the submission if there are support files with WRITE_SUBMISSION_FILES set to False.</p>

</div>

</div>


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




<h6 id="jobbergate_agent.jobbergate.submit.retrieve_submission_file" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">retrieve_submission_file</span>


<span class="doc doc-labels">
<small class="doc doc-label doc-label-async"><code>async</code></small>
</span>

</h6>
<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">retrieve_submission_file</span><span class="p">(</span><span class="n">file</span><span class="p">:</span> <span class="n">JobScriptFile</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span>
</span></code></pre></div>

<div class="doc doc-contents ">

<p>Get a submission file from the backend and return the decoded file content.</p>

</div>

</div>


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




<h6 id="jobbergate_agent.jobbergate.submit.submit_job_script" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">submit_job_script</span>

Expand Down Expand Up @@ -3449,6 +3592,34 @@ <h6 id="jobbergate_agent.jobbergate.submit.unpack_error_from_slurm_response" cla
</div>


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




<h6 id="jobbergate_agent.jobbergate.submit.write_submission_file" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">write_submission_file</span>


<span class="doc doc-labels">
<small class="doc doc-label doc-label-async"><code>async</code></small>
</span>

</h6>
<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">write_submission_file</span><span class="p">(</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">file_content</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">submit_dir</span><span class="p">:</span> <span class="n">Path</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span>
</span></code></pre></div>

<div class="doc doc-contents ">

<p>Write a decoded file content to the submit_dir.</p>

</div>

</div>



</div>

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

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 033b5f9

Please sign in to comment.