Skip to content

Commit

Permalink
doc uodate
Browse files Browse the repository at this point in the history
  • Loading branch information
ardunn committed Sep 11, 2019
1 parent 3e828eb commit 75fff0c
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 4 deletions.
5 changes: 4 additions & 1 deletion docs/_sources/guide.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,17 @@ Alternatively, define it with a string.
wf_creator='my_package.my_module.my_wf_creator'
Alternatively, you can use a function contained in a file not in registered module. While this may work, it is **NOT** recommended!
Alternatively, you can use a function contained in a file **not** in registered module. While this may work, it is **NOT** recommended!

**Example**

.. code-block:: python
wf_creator='/path/to/my_module.my_wf_creator'
For this to work, your file needs to be present at this path on all computing resources used for execution. Additionally, this file should be in the PYTHONPATH. Thus it is **HIGHLY RECOMMENDED** you place your wf_creator
somewhere in a python package (e.g., :code:`my_package.my_module.my_other_module.my_wf_creator`) accessible on all the systems you plan to use rocketsled on.


See the basic tutorial or the :code:`examples` folder for examples of writing wf_creator functions.

Expand Down
4 changes: 3 additions & 1 deletion docs/guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,13 @@ <h3><code class="code docutils literal notranslate"><span class="pre">wf_creator
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">wf_creator</span><span class="o">=</span><span class="s1">&#39;my_package.my_module.my_wf_creator&#39;</span>
</pre></div>
</div>
<p>Alternatively, you can use a function contained in a file not in registered module. While this may work, it is <strong>NOT</strong> recommended!</p>
<p>Alternatively, you can use a function contained in a file <strong>not</strong> in registered module. While this may work, it is <strong>NOT</strong> recommended!</p>
<p><strong>Example</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">wf_creator</span><span class="o">=</span><span class="s1">&#39;/path/to/my_module.my_wf_creator&#39;</span>
</pre></div>
</div>
<p>For this to work, your file needs to be present at this path on all computing resources used for execution. Additionally, this file should be in the PYTHONPATH. Thus it is <strong>HIGHLY RECOMMENDED</strong> you place your wf_creator
somewhere in a python package (e.g., <code class="code docutils literal notranslate"><span class="pre">my_package.my_module.my_other_module.my_wf_creator</span></code>) accessible on all the systems you plan to use rocketsled on.</p>
<p>See the basic tutorial or the <code class="code docutils literal notranslate"><span class="pre">examples</span></code> folder for examples of writing wf_creator functions.</p>
</div>
<div class="section" id="dimensions">
Expand Down
Loading

0 comments on commit 75fff0c

Please sign in to comment.