Getting started (AEN 4.2.0)
===========================

.. raw:: html

    <p>This section contains information and tasks for first-time AEN
    users.</p>
    <p>In this getting started guide, you will:</p>
    <div class="contents local topic" id="contents">
    <ul class="simple">
    <li><a class="reference internal" href="#download-the-aen-cheat-sheet" id="id1">1. Download the AEN cheat sheet</a></li>
    <li><a class="reference internal" href="#access-your-user-home-page" id="id2">2. Access your user home page</a></li>
    <li><a class="reference internal" href="#create-a-new-project" id="id3">3. Create a new project</a></li>
    <li><a class="reference internal" href="#add-collaborators" id="id4">4. Add collaborators</a></li>
    <li><a class="reference internal" href="#a-open-an-example-notebook-or" id="id5">5a. Open an example notebook, OR</a></li>
    <li><a class="reference internal" href="#b-create-a-new-environment-and-notebook" id="id6">5b. Create a new environment and notebook</a></li>
    <li><a class="reference internal" href="#create-checkpoints-for-version-control" id="id7">6. Create checkpoints for version control</a></li>
    <li><a class="reference internal" href="#share-your-notebook-and-environment-with-others" id="id8">7. Share your notebook and environment with others</a></li>
    <li><a class="reference internal" href="#see-what-to-do-next" id="id9">8. See what to do next</a></li>
    </ul>
    </div>
    <div class="section" id="download-the-aen-cheat-sheet">
    <span id="getting-started-dl-aen-cs"></span><h2><a class="toc-backref" href="#id1">1. Download the AEN cheat sheet</a><a class="headerlink" href="#download-the-aen-cheat-sheet" title="Permalink to this headline">¶</a></h2>
    <p>Before you start, download and print the <a class="reference internal" href="cheatsheet.html"><span class="doc">AEN cheat sheet</span></a> for easy reference.</p>
    </div>
    <div class="section" id="access-your-user-home-page">
    <span id="getting-started-access-hp"></span><h2><a class="toc-backref" href="#id2">2. Access your user home page</a><a class="headerlink" href="#access-your-user-home-page" title="Permalink to this headline">¶</a></h2>
    <p>After your administrator has set up your server and new Anaconda
    account, you will receive a welcome email.</p>
    <ol class="arabic">
    <li><p class="first">Click the link in the email to open the AEN login page.</p>
    </li>
    <li><p class="first">Enter your AEN account username and password.</p>
    <p>NOTE: Some administrators allow you to create your own
    account. If your administrator has allowed this, in the
    create a new account section, create your own username and
    password.</p>
    </li>
    <li><p class="first">Click the Login button.</p>
    <p>Your user home page, where all good things happen, is
    displayed:</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-index_profilescreen41.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-index_profilescreen41.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-index_profilescreen41.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </li>
    </ol>
    </div>
    <div class="section" id="create-a-new-project">
    <span id="getting-started-create-np"></span><h2><a class="toc-backref" href="#id3">3. Create a new project</a><a class="headerlink" href="#create-a-new-project" title="Permalink to this headline">¶</a></h2>
    <ol class="arabic">
    <li><p class="first">There are 2 ways to create a new project in AEN:</p>
    <ul>
    <li><p class="first">On the right side of the AEN task bar, click on the New Project icon:</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new1.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new1.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new1.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </li>
    <li><p class="first">On your home page, click the New project button:</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new1b.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new1b.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new1b.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </li>
    </ul>
    </li>
    <li><p class="first">On the Project page that is displayed, type a name for your
    project, such as &#8220;Testing.&#8221;</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new2.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new2.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-projects_new2.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </li>
    <li><p class="first">Type a summary of the project so you can recognize it later.</p>
    </li>
    <li><p class="first">Select whether your project will be public or private.</p>
    </li>
    <li><p class="first">Verify that the default data center is selected.</p>
    <p>TIP: You can update the project summary and description at
    any time from the <strong>Project</strong> menu in the Project Settings. To
    return to your project at any time, click the project name.</p>
    </li>
    <li><p class="first">Click the Next button.</p>
    <p>Your new project&#8217;s home page is displayed:</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-projects_created.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-projects_created.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-projects_created.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </li>
    <li><p class="first">To change the project settings, click the Project Settings
    icon on at the top right.</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-project_settings.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-project_settings.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-project_settings.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </li>
    <li><p class="first">Modify the summary or add a description of the project.</p>
    <p>TIP: A project description is recommended, and may be written
    in Markdown syntax (plain text valid Markdown).</p>
    <p>To see how Markdown will be displayed, in the description
    area, click the <strong>Preview</strong> tab.</p>
    </li>
    </ol>
    </div>
    <div class="section" id="add-collaborators">
    <span id="getting-started-add-collab"></span><h2><a class="toc-backref" href="#id4">4. Add collaborators</a><a class="headerlink" href="#add-collaborators" title="Permalink to this headline">¶</a></h2>
    <p>You can add team members to your project as collaborators. Adding team members
    to your projects makes collaboration easy because they have full access to the
    project&#8217;s applications, files and services.</p>
    <p>When you add team members, their home directory is mounted in the project.
    There is no need to download and email data or scripts&#8212;team members can work
    on the same files in the same environment in which you are working.</p>
    <p>To add collaborators to your project:</p>
    <ol class="arabic simple">
    <li>From your project home page, in the Team box, begin typing a teammate&#8217;s username.</li>
    <li>In the list that is displayed, select the teammate&#8217;s username.</li>
    <li>Click the Add button.</li>
    </ol>
    <blockquote>
    <div><div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-projects_collaborators.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-projects_collaborators.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-projects_collaborators.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </div></blockquote>
    <ol class="arabic simple">
    <li>Repeat these steps for each team member you want to add as a collaborator.</li>
    </ol>
    <p>TIP: You can add or remove team members any time from the <strong>Team</strong> menu in
    Project Settings. You can also modify a team member&#8217;s read, write or execute
    permissions at any time from the <a class="reference internal" href="basic-tasks/apps/use-workbench.html"><span class="doc">Using Workbench</span></a>.</p>
    </div>
    <div class="section" id="a-open-an-example-notebook-or">
    <span id="getting-started-open-nb"></span><h2><a class="toc-backref" href="#id5">5a. Open an example notebook, OR</a><a class="headerlink" href="#a-open-an-example-notebook-or" title="Permalink to this headline">¶</a></h2>
    <ol class="arabic">
    <li><p class="first">From your project home page, click the Jupyter Notebooks icon.</p>
    </li>
    <li><p class="first">On the File View page, click the Examples folder.</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-exnbs.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-exnbs.png" src="../../../_images/ae-notebooks/4.2.0/aen-exnbs.png" style="width: 50%;" /></a>
    </div>
    </li>
    </ol>
    <blockquote>
    <div><div class="line-block">
    <div class="line"><br /></div>
    </div>
    </div></blockquote>
    <ol class="arabic simple">
    <li>Select any of the example notebooks.</li>
    <li>To see the default results of the formulas used in the displayed notebook, in the <strong>Cell</strong> menu, select Run All.</li>
    <li>To experiment with changing the notebook, edit any of the formulas in the notebook.</li>
    <li>In the <strong>Cell</strong> menu, select Run All.</li>
    </ol>
    <p>Any differences resulting from your edits are displayed.</p>
    </div>
    <div class="section" id="b-create-a-new-environment-and-notebook">
    <span id="getting-started-create-new-env"></span><h2><a class="toc-backref" href="#id6">5b. Create a new environment and notebook</a><a class="headerlink" href="#b-create-a-new-environment-and-notebook" title="Permalink to this headline">¶</a></h2>
    <p>If you are already familiar with creating notebooks, you can easily set up a
    new environment with the programs you need&#8212;like SciPy and NumPy&#8212;then open
    a new notebook and make your edits.</p>
    <p>To create a new environment:</p>
    <ol class="arabic simple">
    <li>From your project home page, click the Jupyter Notebooks icon.</li>
    <li>On the File View page, click the <strong>Conda</strong> tab.</li>
    <li>To add a new conda environment, on the top right of the <strong>Conda</strong> tab, click the + icon.</li>
    <li>Type a name for your environment.</li>
    <li>Select Python 2, Python 3 or R language kernel.</li>
    <li>Click the Create button.</li>
    <li>To activate your new environment, click its name.</li>
    </ol>
    <p>The packages that are available and installed in your new environment are displayed.</p>
    <div class="section" id="adding-scipy-and-numpy-packages">
    <span id="getting-started-add-pkgs"></span><h3>Adding SciPy and Numpy packages<a class="headerlink" href="#adding-scipy-and-numpy-packages" title="Permalink to this headline">¶</a></h3>
    <ol class="arabic simple">
    <li>In the available packages section, search for the package name <code class="docutils literal"><span class="pre">numpy</span></code>&#8212;all lower case.</li>
    <li>In the results section, next to numpy, select the checkbox.</li>
    </ol>
    <blockquote>
    <div><blockquote>
    <div><div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-env-numpy.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-env-numpy.png" src="../../../_images/ae-notebooks/4.2.0/aen-env-numpy.png" style="width: 50%;" /></a>
    </div>
    </div></blockquote>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    </div></blockquote>
    <ol class="arabic simple">
    <li>Click the Install icon.</li>
    <li>To confirm your installation, click the Install button.</li>
    </ol>
    <p>Numpy is displayed in the installed packages section&#8212;if not, click the Refresh button. Repeat these steps to install the Scipy package&#8212;searching for <code class="docutils literal"><span class="pre">scipy</span></code> in step 1.</p>
    <p>TIP: You can return to this screen at any time to add additional packages to this environment.</p>
    </div>
    <div class="section" id="creating-a-new-notebook-in-your-environment">
    <span id="getting-started-create-new-nb"></span><h3>Creating a new notebook in your environment<a class="headerlink" href="#creating-a-new-notebook-in-your-environment" title="Permalink to this headline">¶</a></h3>
    <ol class="arabic">
    <li><p class="first">From the AEN homepage, click the <strong>Files</strong> tab.</p>
    </li>
    <li><p class="first">On the top right of the <strong>Files</strong> tab, click the New button.</p>
    </li>
    <li><p class="first">Under Notebooks, select the Python environment with the name
    you entered while <a class="reference internal" href="#getting-started-create-new-env"><span class="std std-ref">creating a new environment</span></a>.</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-env.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-env.png" src="../../../_images/ae-notebooks/4.2.0/aen-env.png" style="width: 50%;" /></a>
    </div>
    </li>
    </ol>
    <blockquote>
    <div><div class="line-block">
    <div class="line"><br /></div>
    </div>
    <blockquote>
    <div>NOTE: If you do not see your new environment listed under Notebooks, next to the New button, click the Refresh button.</div></blockquote>
    </div></blockquote>
    <p>A new locked notebook is displayed. Paste or write some code to execute when you are ready.</p>
    </div>
    </div>
    <div class="section" id="create-checkpoints-for-version-control">
    <span id="getting-started-create-cp"></span><h2><a class="toc-backref" href="#id7">6. Create checkpoints for version control</a><a class="headerlink" href="#create-checkpoints-for-version-control" title="Permalink to this headline">¶</a></h2>
    <p>Whether you are exploring an existing notebook, or creating a new one, you can
    easily create checkpoints, return to an earlier version, compare two different
    versions and save them for reference.</p>
    <p>To create a checkpoint, in the <strong>File</strong> menu, select Save and Checkpoint:</p>
    <div class="figure">
    <a class="reference internal image-reference" href="../../../_images/ae-notebooks/4.2.0/aen-user-checkpoint.png"><img alt="../../../_images/ae-notebooks/4.2.0/aen-user-checkpoint.png" src="../../../_images/ae-notebooks/4.2.0/aen-user-checkpoint.png" style="width: 50%;" /></a>
    </div>
    <div class="line-block">
    <div class="line"><br /></div>
    </div>
    <p>To revert your notebook to a previous checkpoint, in the <strong>File</strong> menu, select
    Revert to Checkpoint.</p>
    <p>NOTE: For more information about revision control features, including creating
    commits and comparing differences,
    see <a class="reference internal" href="basic-tasks/apps/jupyter/use-rcm-ext.html"><span class="doc">Using the Revision Control Mechanism extension</span></a>.</p>
    </div>
    <div class="section" id="share-your-notebook-and-environment-with-others">
    <span id="getting-started-share"></span><h2><a class="toc-backref" href="#id8">7. Share your notebook and environment with others</a><a class="headerlink" href="#share-your-notebook-and-environment-with-others" title="Permalink to this headline">¶</a></h2>
    <p>See <a class="reference internal" href="basic-tasks/projects/share-projects-notebooks.html"><span class="doc">Sharing projects and notebooks</span></a>.</p>
    </div>
    <div class="section" id="see-what-to-do-next">
    <h2><a class="toc-backref" href="#id9">8. See what to do next</a><a class="headerlink" href="#see-what-to-do-next" title="Permalink to this headline">¶</a></h2>
    <p>Now that you have completed the Getting Started guide, you are
    ready to move on to <a class="reference internal" href="basic-tasks/index.html"><span class="doc">basic tasks</span></a> and
    <a class="reference internal" href="adv-tasks/index.html"><span class="doc">advanced tasks</span></a>.</p>
    </div>
