Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Sep 6, 2024
1 parent cad1b9e commit 112f469
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 32 deletions.
Binary file modified .doctrees/_source/tutorials/slurm/README.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
30 changes: 15 additions & 15 deletions _source/tutorials/slurm/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,21 +114,21 @@ <h2>Instructions for Customization<a class="headerlink" href="#instructions-for-
<ol class="arabic simple">
<li><p><strong>Resource Requests:</strong></p>
<ul class="simple">
<li><p>Replace TIME<sub>LIMIT</sub> with the desired wall clock time limit
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">TIME_LIMIT</span></code> with the desired wall clock time limit
(e.g., <code class="docutils literal notranslate"><span class="pre">168:00:00</span></code> for 168 hours).</p></li>
<li><p>Replace YOUR<sub>ALLOCATIONACCOUNT</sub> with your specific
allocation account.</p></li>
<li><p>Replace NUMBER<sub>OFNODES</sub> with the number of nodes you need
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">YOUR_ALLOCATION_ACCOUNT</span></code> with your specific allocation
account.</p></li>
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">NUMBER_OF_NODES</span></code> with the number of nodes you need
(e.g., <code class="docutils literal notranslate"><span class="pre">1</span></code>).</p></li>
<li><p>Replace NUMBER<sub>OFTASKS</sub> with the number of tasks to run
(e.g., <code class="docutils literal notranslate"><span class="pre">1</span></code>).</p></li>
<li><p>Replace CPUS<sub>PERTASK</sub> with the number of CPUs per task
(e.g., <code class="docutils literal notranslate"><span class="pre">8</span></code>).</p></li>
<li><p>Replace GPUS<sub>PERTASK</sub> with the type and number of GPUs per
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">NUMBER_OF_TASKS</span></code> with the number of tasks to run (e.g.,
<code class="docutils literal notranslate"><span class="pre">1</span></code>).</p></li>
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">CPUS_PER_TASK</span></code> with the number of CPUs per task (e.g.,
<code class="docutils literal notranslate"><span class="pre">8</span></code>).</p></li>
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">GPUS_PER_TASK</span></code> with the type and number of GPUs per
task (e.g., <code class="docutils literal notranslate"><span class="pre">v100:4</span></code>).</p></li>
<li><p>Replace MEMORY<sub>PERNODE</sub> with the total memory per node
(e.g., <code class="docutils literal notranslate"><span class="pre">64G</span></code>).</p></li>
<li><p>Replace JOB<sub>NAME</sub> with a name for your job (e.g.,
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">MEMORY_PER_NODE</span></code> with the total memory per node (e.g.,
<code class="docutils literal notranslate"><span class="pre">64G</span></code>).</p></li>
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">JOB_NAME</span></code> with a name for your job (e.g.,
<code class="docutils literal notranslate"><span class="pre">wepy_run</span></code>).</p></li>
</ul>
</li>
Expand All @@ -142,10 +142,10 @@ <h2>Instructions for Customization<a class="headerlink" href="#instructions-for-
</li>
<li><p><strong>Home and Log Directory:</strong></p>
<ul class="simple">
<li><p>Set HOME<sub>DIR</sub> to the directory where your project files are
<li><p>Set <code class="docutils literal notranslate"><span class="pre">HOME_DIR</span></code> to the directory where your project files are
located.</p></li>
<li><p>Ensure LOG<sub>DIR</sub> points to where you want the log files to
be saved.</p></li>
<li><p>Ensure <code class="docutils literal notranslate"><span class="pre">LOG_DIR</span></code> points to where you want the log files to be
saved.</p></li>
</ul>
</li>
<li><p><strong>CUDA Module:</strong></p>
Expand Down
30 changes: 15 additions & 15 deletions _sources/_source/tutorials/slurm/README.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -63,21 +63,21 @@ Instructions for Customization

#. **Resource Requests:**

- Replace TIME\ :sub:`LIMIT` with the desired wall clock time limit
- Replace ``TIME_LIMIT`` with the desired wall clock time limit
(e.g., ``168:00:00`` for 168 hours).
- Replace YOUR\ :sub:`ALLOCATIONACCOUNT` with your specific
allocation account.
- Replace NUMBER\ :sub:`OFNODES` with the number of nodes you need
- Replace ``YOUR_ALLOCATION_ACCOUNT`` with your specific allocation
account.
- Replace ``NUMBER_OF_NODES`` with the number of nodes you need
(e.g., ``1``).
- Replace NUMBER\ :sub:`OFTASKS` with the number of tasks to run
(e.g., ``1``).
- Replace CPUS\ :sub:`PERTASK` with the number of CPUs per task
(e.g., ``8``).
- Replace GPUS\ :sub:`PERTASK` with the type and number of GPUs per
- Replace ``NUMBER_OF_TASKS`` with the number of tasks to run (e.g.,
``1``).
- Replace ``CPUS_PER_TASK`` with the number of CPUs per task (e.g.,
``8``).
- Replace ``GPUS_PER_TASK`` with the type and number of GPUs per
task (e.g., ``v100:4``).
- Replace MEMORY\ :sub:`PERNODE` with the total memory per node
(e.g., ``64G``).
- Replace JOB\ :sub:`NAME` with a name for your job (e.g.,
- Replace ``MEMORY_PER_NODE`` with the total memory per node (e.g.,
``64G``).
- Replace ``JOB_NAME`` with a name for your job (e.g.,
``wepy_run``).

#. **Conda Setup:**
Expand All @@ -89,10 +89,10 @@ Instructions for Customization

#. **Home and Log Directory:**

- Set HOME\ :sub:`DIR` to the directory where your project files are
- Set ``HOME_DIR`` to the directory where your project files are
located.
- Ensure LOG\ :sub:`DIR` points to where you want the log files to
be saved.
- Ensure ``LOG_DIR`` points to where you want the log files to be
saved.

#. **CUDA Module:**

Expand Down
2 changes: 1 addition & 1 deletion news.rss
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<title>wepy News</title>
<link></link>
<description>Various announcements related to the wepy project.</description>
<lastBuildDate>Fri, 06 Sep 2024 14:52:56 GMT</lastBuildDate>
<lastBuildDate>Fri, 06 Sep 2024 15:04:09 GMT</lastBuildDate>
<generator>sphinxcontrib-newsfeed</generator>
<item>
<title>RSS Feed Now Available</title>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 112f469

Please sign in to comment.