.. _checklist-before-you-start:

Checklist Before You Quickstart
===============================

When the CS system is installed at your site, it is in a CS cluster that looks similar to the following diagram. Before you can start using the CS
system, check with your system administrator and go over the following prerequisites first. 

.. Note::

	This checklist only applies to the Slurm/Singularity workflow, which we support for pipeline models only. 

.. Note::

	Slurm wrapper scripts (``csrun_wse`` and ``csrun_cpu``) may be customized for your particular environment by your sysadmins and may look different than what is shown below. Check whether your Sysadmin's local documentation is available and whether there are any special instructions for your CS-2.

.. _cs-getting-started:
.. figure:: ../images/cs-getting-started.png
    :align: center
    :width: 600 px


.. raw:: html

    <div class="full-width">
    <div class="timeline">
    <!-- Stepper HTML -->
    <div class="step">
        <div>
            <div class="circle">1</div>
        </div>
        <div>
            <div class="step-title">Cerebras SIF container</div>
            <div class="step-caption">The <a class="reference external" href="https://sylabs.io/guides/3.7/user-guide/">Singularity</a> software is installed on all the nodes, including the chief and the worker nodes, and can launch Cerebras container that consists of the Cerebras Graph Compiler (CGC) and other necessary libraries. </div> 
        </div>
    </div>
    <div class="step">
        <div>
            <div class="circle">2</div>
        </div>
        <div>
            <div class="step-title">Slurm orchestrator</div>
            <div class="step-caption">The orchestrator software <a class="reference external" href="https://slurm.schedmd.com/quickstart.html">Slurm</a> is installed and is running on all the CPU nodes: on the chief node and on all the worker nodes. The orchestrator software Slurm performs the coordination between the CS system and the nodes in the CS cluster. </div>
        </div>
    </div>

    <div class="step">
        <div>
            <div class="circle">3</div>
        </div>
        <div>
            <div class="step-title">Hostnames</div>
            <div class="step-caption">You have the hostnames of the chief and the worker nodes. You will log in to the chief node and perform all your work on the chief node. You need hostnames of the worker nodes for debugging. </div>
        </div>
    </div>

    <div class="step">
        <div>
            <div class="circle">4</div>
        </div>
        <div>
            <div class="step-title">IP address of CS system</div>
            <div class="step-caption">You have the IP address and the port number of the network attached CS system accelerator. You pass this IP address and port number to the <code class="docutils literal notranslate"><span class="pre">--cs_ip</span></code> flag of your runtime scripts during compiling and running your models. </div>
        </div>
    </div>
    <div class="step">
        <div>
            <div class="circle">5</div>
        </div>
        <div>
            <div class="step-title">Login steps</div>
            <div class="step-caption">Steps to log in to the chief node of the CS system cluster. Logging into the chief node is done by using <code class="docutils literal notranslate"><span class="pre">ssh</span></code>. </div>
        </div>
    </div>


    <div class="step">
    <div>
    <div class="circle">7</div>
    </div>
    <div>
    <div class="step-title">Done</div>
    </div>
    </div>
    <!-- End Stepper HTML -->
    </div>
    </div>


.. attention::

	Proceed to work on the CS system only after you have completed the above checklist.


.. .. raw:: html

	<div class="full-width">
	<div class="timeline-container">

	<div class="timeline-item" date-is='Slurm orchestrator'>
		<h1>Slurm orchestrator</h1>
		<p>
			Some description.
		</p>
	</div>

	<div class="timeline-item" date-is='07-01-2022'>
		<h1>Slurm other orchestrator</h1>
		<p>
			Some description.
		</p>
	</div>

	<div class="timeline-item" date-is='07-01-2022'>
		<h1>This is ::last-child so border fades</h1>
		<p>
			Some description.
		</p>
	</div>

	</div>
	</div>