Projects (AEN 4.0)
==================

.. raw:: html

    <p>Everything in Anaconda Enterprise Notebooks begins by creating or
    opening a project. After that you can set up a special environment
    with the packages you want, add team members and set their access
    permissions. You can also modify your project settings.</p>
    <p>To begin, log onto your AEN account. This brings you to your user
    profile page. Now you are ready to open an existing project or
    create a new project.</p>
    <div class="section" id="create-new-project">
    <h2>Create new project<a class="headerlink" href="#create-new-project" title="Permalink to this headline">¶</a></h2>
    <p>To create a new project, click on the new project icon on the right hand
    side of the upper Anaconda Enterprise Notebooks task bar:</p>
    <p><img alt="image0" src="../../../_images/ae-notebooks/4.0/user/projects_new1.png" /></p>
    <p>Or on your profile page, you can click the <em>New project</em> button:</p>
    <p><img alt="image1" src="../../../_images/ae-notebooks/4.0/user/projects_new1b.png" /></p>
    <p>This brings you to the project page where you can name your project, select
    whether it will be public or private, and include a summary
    of your project:</p>
    <p><img alt="image2" src="../../../_images/ae-notebooks/4.0/user/projects_new2.png" /></p>
    <p>TIP: You can update the summary and description any time from your
    Project settings&#8217; Project menu as described below.</p>
    <p>After you have filled in the new project form, click the <em>Next</em> button at
    the bottom right.</p>
    <p>This opens your new project&#8217;s home page or project dashboard:</p>
    <p><img alt="image3" src="../../../_images/ae-notebooks/4.0/user/projects_created.png" /></p>
    <p>Use the Project Settings icon at the top right of the project page to
    modify the summary or add a description of the project.</p>
    <p>A project description is
    recommended, and may optionally be written in Markdown syntax (plain text
    valid Markdown).  Click the Preview tab in the description area to see how the
    Markdown will appear.</p>
    <p>TIP: You can add or update your project&#8217;s summary and description any time
    from the Project Settings Project menu described below.</p>
    </div>
    <div class="section" id="add-team-members">
    <h2>Add team members<a class="headerlink" href="#add-team-members" title="Permalink to this headline">¶</a></h2>
    <p>Now you may add team members to your new project if you wish.
    Adding team members to your projects makes collaboration easy
    in Anaconda Enterprise Notebooks. Team members have full access to the
    project applications, files and services. When you add a team member,
    their home directory is mounted in the project. There is no need to
    download and email data or scripts &#8211; your team member can work on the
    same files in the same environment in which you are working.</p>
    <p>To add new team members to your project, in the Team box start typing the first
    few letters of their username. The type-ahead feature displays
    all team members with that spelling so you can quickly add team members.</p>
    <p>TIP: You can add or remove team members any time from the Project Settings
    Team menu described below. You can also modify their read, write or
    execute permissions any time from the <a class="reference internal" href="workbench.html"><span class="doc">Workbench</span></a> app.</p>
    </div>
    <div class="section" id="project-drive-and-directory">
    <h2>Project drive and directory<a class="headerlink" href="#project-drive-and-directory" title="Permalink to this headline">¶</a></h2>
    <p>Each project has a project drive attached that all team members can access.
    The size of the project drive is not limited by Anaconda Enterprise Notebooks.
    Please contact your system administrator if you find you do not have sufficent
    space.</p>
    <p>Each project also has a separate project directory on the project drive.  The
    project directory is a separate directory from the owner&#8217;s and team members&#8217;
    home directories, for project files and data so team members can share and
    have equal access.</p>
    <p>NOTE: The path to your project directory is <code class="docutils literal"><span class="pre">/projects/&lt;project_owner&gt;/&lt;project_name&gt;</span></code></p>
    </div>
    <div class="section" id="project-settings-menu">
    <h2>Project settings menu<a class="headerlink" href="#project-settings-menu" title="Permalink to this headline">¶</a></h2>
    <p>Access your project settings from the Project page, the Project Settings
    3-gear icon at the top right:</p>
    <p><img alt="image4" src="../../../_images/ae-notebooks/4.0/user/project_settings.png" /></p>
    <p>Here you will find settings for the Project, Team, Admin and Info.</p>
    <div class="section" id="project-settings">
    <h3>Project settings<a class="headerlink" href="#project-settings" title="Permalink to this headline">¶</a></h3>
    <p>Status. The project settings Status box allows you to toggle between
    manually starting and stopping your project. Stopping a project stops all the
    apps launched for that project. Projects do use resources such as memory and
    compute cycles when running, so it is best to stop projects when they are not
    in use.</p>
    <p>Project. In the Project box you can update your project&#8217;s summary
    and description.</p>
    <p>Description. In the Description box you can use plain text or markdown syntax.
    Click the Preview tab to see how the markdown description looks.
    Click the Submit button at the bottom left to save your changes:</p>
    <p><img alt="image5" src="../../../_images/ae-notebooks/4.0/user/projects_project.png" /></p>
    </div>
    <div class="section" id="team-settings">
    <h3>Team settings<a class="headerlink" href="#team-settings" title="Permalink to this headline">¶</a></h3>
    <p>From the project settings Team menu, you may easily add or remove team
    members who have access to this project. Simply type in a few letters
    of the username you would like to include, then select them from the
    usernames that appear. To add them, click the &#8216;Add&#8217; button. Repeat for
    each team member you wish to add to this project.</p>
    <p><img alt="image6" src="../../../_images/ae-notebooks/4.0/user/manage_team_members.png" /></p>
    <p>Removing team members is just as easy as adding them. Click the red
    &#8216;Remove&#8217; link next to the name of the user you would like to remove.</p>
    </div>
    <div class="section" id="admin-settings">
    <h3>Admin settings<a class="headerlink" href="#admin-settings" title="Permalink to this headline">¶</a></h3>
    <p>From the project settings Admin menu, you may <em>make this project
    private or public</em>.</p>
    <p>You may also <em>reclaim ownership of a project</em>. Ownership of all files
    and folders created by the team members on this project will be
    transferred to you. Project files and folders are copied and renamed.</p>
    <p>TIP: Be sure you have stopped the project from the Project Settings menu
    so team members cannot make changes while you are changing ownership.</p>
    <p><em>Delete this project</em> deletes all project files and information about it.
    There is no &#8220;undo&#8221; option. Be sure you have downloaded a copy of all files
    that you may want to save.</p>
    <p><em>Move this project to a new compute node</em> if you have multiple resources
    available and want to move them to the other resource. The project must
    exist on both compute nodes. Make sure that this is done before you move.</p>
    <p><img alt="image7" src="../../../_images/ae-notebooks/4.0/user/project_admin.png" /></p>
    </div>
    <div class="section" id="info-settings">
    <h3>Info settings<a class="headerlink" href="#info-settings" title="Permalink to this headline">¶</a></h3>
    <p>The info settings menu provides details about your project. See whether it
    is currently running or stopped, when it was created, when it was last
    accessed, and data center in which it is running.</p>
    <p><img alt="image8" src="../../../_images/ae-notebooks/4.0/user/project_info.png" /></p>
    </div>
    </div>
    <div class="section" id="using-search">
    <h2>Using Search<a class="headerlink" href="#using-search" title="Permalink to this headline">¶</a></h2>
    <p>You can search for projects and files using the Search box at the top of
    the screen. When you are viewing a project home page, the Search box
    will search for files within the current project. Otherwise, it will
    search for projects containing files that match your search criteria.</p>
    <p>Your search results will include only files and projects which
    you have permissions to view. To search, just enter a string of
    text and press enter.</p>
    <p>TIP: Search matches by glob pattern in a similar manner to file
    matching on command lines.  For example, to find projects in the &#8216;Test&#8217;
    family that are numbered from 00 to 99, search for <code class="docutils literal"><span class="pre">Test-??</span></code>.  To find
    all projects whose name ends in &#8216;Stats&#8217;, use <code class="docutils literal"><span class="pre">*Stats</span></code>.</p>
    <p><img alt="image9" src="../../../_images/ae-notebooks/4.0/user/search_box.png" /></p>
    <p>After pressing enter your search results will appear. Click on the plus
    (&#8220;+&#8221;) icon to show the files that search returned for the given
    project:</p>
    <p><img alt="image10" src="../../../_images/ae-notebooks/4.0/user/search_results_expansion_icon.png" /></p>
    <p>The results are limited to public projects and those private
    projects to which you have at least view access. If you click on a filename,
    the file will open for you to view:</p>
    <p><img alt="image11" src="../../../_images/ae-notebooks/4.0/user/search_results_details.png" /></p>
    <p>Clicking on the project name instead of the plus (&#8220;+&#8221;) sign will take
    you to the project.</p>
    <div class="section" id="saving-a-search">
    <h3>Saving a search<a class="headerlink" href="#saving-a-search" title="Permalink to this headline">¶</a></h3>
    <p>You can save a search for future use. At the top of the search results
    clicking on the &#8220;save this search&#8221; text will save the search:</p>
    <p><img alt="image12" src="../../../_images/ae-notebooks/4.0/user/save_search.png" /></p>
    <p>The &#8220;save this search&#8221; text will change to read &#8220;stored&#8221;.</p>
    <p>The saved search can be found on your home page in the &#8220;Saved Searches&#8221; box
    that lists all the projects for which you are a contributor.</p>
    <p>To remove a saved search, click the &#8220;x&#8221; next to the name of the search:</p>
    <p><img alt="image14" src="../../../_images/ae-notebooks/4.0/user/saved_searches.png" /></p>
    </div>
    <div class="section" id="search-tips">
    <h3>Search tips<a class="headerlink" href="#search-tips" title="Permalink to this headline">¶</a></h3>
    <p>These types of files are included in search results:</p>
    <ul class="simple">
    <li><code class="docutils literal"><span class="pre">.py</span></code>: Python source files</li>
    <li><code class="docutils literal"><span class="pre">.ipynb</span></code>: IPython/Jupyter notebooks</li>
    <li><code class="docutils literal"><span class="pre">.txt</span></code>: plain text files</li>
    <li><code class="docutils literal"><span class="pre">.md</span></code>: Markdown files</li>
    </ul>
    <p>You can use any of the following search constructs:</p>
    <ul class="simple">
    <li>Ordinary words will match the full-text contents of any file</li>
    <li>Wildcards are permitted (<code class="docutils literal"><span class="pre">John*</span></code> will match <code class="docutils literal"><span class="pre">John</span></code> and
    <code class="docutils literal"><span class="pre">Johnny</span></code>).  These are called &#8220;glob patterns&#8221; and resemble the
    usage in command-line shells.</li>
    <li>Combine queries using <code class="docutils literal"><span class="pre">AND</span></code> or <code class="docutils literal"><span class="pre">OR</span></code>, and group them using
    parentheses.</li>
    </ul>
    <p>You can also search in specific metadata fields:</p>
    <ul class="simple">
    <li><code class="docutils literal"><span class="pre">imports:name</span></code> will match files that import the module &#8216;name&#8217;</li>
    <li><code class="docutils literal"><span class="pre">uses:name</span></code> will match files that reference the identifier &#8216;name&#8217;.
    Referenced names include functions and globals imported from other
    modules, as well as the names of methods invoked on any object.</li>
    <li><code class="docutils literal"><span class="pre">defines:name</span></code> will match files that define the identifier &#8216;name&#8217;.
    Defined names include functions defined at global scope, class names,
    and method names within classes.</li>
    <li><code class="docutils literal"><span class="pre">acl:user</span></code> will match files that the user named &#8216;user&#8217; has read
    access to.</li>
    </ul>
    <p>Files that are modified while a project is running will automatically be
    re-indexed. Normally, this will occur shortly after the files are
    modified. If you create or update a large number of files (for example,
    cloning a git repository or copying a directory), the search results may
    take several minutes to update.</p>
    <p>If files are modified while the project is not running, they will be
    re-indexed once the project is started.</p>
    </div>
    </div>
    <div class="section" id="tag-a-project">
    <h2>Tag a project<a class="headerlink" href="#tag-a-project" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="add-or-remove-tags">
    <h3>Add or Remove Tags<a class="headerlink" href="#add-or-remove-tags" title="Permalink to this headline">¶</a></h3>
    <p><em>Tags</em> are a way to group similar or related projects, to
    identify a project so that it is easier to find at a later date, or as a
    way to let others know about a project.</p>
    <p>You can create and remove tags on any project that you have access to.</p>
    <p>To add a new tag, go to the project&#8217;s main page.  In the &#8220;Tags&#8221; box on the right
    of the page enter the name of the tag you wish to add and click the &#8220;Add&#8221; button.
    The new tag will be added and show up in the &#8220;Tags&#8221; list.</p>
    <p>To remove a tag from a project, click on the &#8220;x&#8221; next to the tag&#8217;s name:</p>
    <p><img alt="image15" src="../../../_images/ae-notebooks/4.0/user/tag_add.png" /></p>
    <p>If the tag was not already visible from your main home page in the
    &#8220;Tag&#8221; list it will be added. If the tag already was showing because
    another project had the tag, then the number next to the tag name
    will be incremented:</p>
    <p><img alt="image17" src="../../../_images/ae-notebooks/4.0/user/tag_on_dashboard.png" /></p>
    </div>
    <div class="section" id="list-tagged-projects">
    <h3>List tagged projects<a class="headerlink" href="#list-tagged-projects" title="Permalink to this headline">¶</a></h3>
    <p>Just click on a tag name and a list of projects with that tag will
    be shown. Example, here we click the tag &#8220;science&#8221;:</p>
    <p><img alt="image18" src="../../../_images/ae-notebooks/4.0/user/tag_click.png" /></p>
    <p>The results list shows both public projects and private
    projects that you can access.</p>
    <p><img alt="image19" src="../../../_images/ae-notebooks/4.0/user/tag_results.png" /></p>
    <p>Clicking on a project in the tagged list will take you to that
    project&#8217;s home page.</p>
    </div>
    </div>
    <div class="section" id="star-a-project">
    <h2>Star a project<a class="headerlink" href="#star-a-project" title="Permalink to this headline">¶</a></h2>
    <p>When you <em>star</em> a project, it makes it more likely that the project will
    appear in the <em>Top Rated</em> project list on the Dashboard home page.</p>
    <p>To star a project,
    just click the star icon at the upper right on the project page. To
    unstar a project, just click the star again.</p>
    <p>TIP: Adding or removing stars
    on a project does not affect anyone else&#8217;s stars that they may have
    added.</p>
    <p><img alt="image20" src="../../../_images/ae-notebooks/4.0/user/star.png" /></p>
    <p>The number next to the project in the Top Rated list is the number of stars
    that have been given to that project. Clicking on a project in the list
    will take you to a view of that project&#8217;s home page.</p>
    <p><img alt="image21" src="../../../_images/ae-notebooks/4.0/user/star_list.png" /></p>
    </div>
    <div class="section" id="related-projects">
    <h2>Related projects<a class="headerlink" href="#related-projects" title="Permalink to this headline">¶</a></h2>
    <p>On a project&#8217;s home page, on the right side, there is a list of
    &#8220;Related Projects&#8221;. The projects listed in this
    section are automatically based on how similar their fields are to the
    project being viewed:</p>
    <p><img alt="image22" src="../../../_images/ae-notebooks/4.0/user/recommended_projects.png" /></p>
    </div>
    <div class="section" id="recommendations">
    <h2>Recommendations<a class="headerlink" href="#recommendations" title="Permalink to this headline">¶</a></h2>
    <p>The recommendation engine leverages the search functionality to locate
    similar files and projects.  In determining what should be listed in
    <em>Related Projects</em>, the recommendation engine scans the files in the
    project.  The terms found in those documents are weighted to determine which
    ones are to be used for the &#8220;likeness&#8221; search.  A search is then performed,
    with extra weighting given to the <em>uses</em> and <em>imports</em> keywords.  The engine
    finds the files and the projects that are most similar to the current
    project&#8217;s files.  The results are scored and the top scoring matches are
    displayed for public projects and those private projects to which you have
    access.  The recommendation is based on how similar the files are between
    the projects.</p>
    </div>
    <div class="section" id="collaborators">
    <h2>Collaborators<a class="headerlink" href="#collaborators" title="Permalink to this headline">¶</a></h2>
    <p>A project&#8217;s home page has a section that lists your top collaborators.
    This list is composed of those collaborators who share the most projects
    in common with you.</p>
    <p>If you click on one of the collaborator&#8217;s names, you will be taken to a view
    of their home page where you can see all public projects and private projects
    they have shared with you.</p>
    <p><img alt="image23" src="../../../_images/ae-notebooks/4.0/user/top_collaborators.png" /></p>
    </div>
