=====================
Quickstart (AER 2.24)
=====================

.. raw:: html

    <div class="section" id="find-download-and-install-packages">
    <h2>Find, download and install packages<a class="headerlink" href="#find-download-and-install-packages" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="search-for-a-package">
    <h3>Search for a package<a class="headerlink" href="#search-for-a-package" title="Permalink to this headline">¶</a></h3>
    <p>You don&#8217;t need an Anaconda Repository account, or even to be logged in,
    to search for packages, notebooks, environments or installers, and to
    download and install them.</p>
    <p>You do need an account to access
    <a class="reference internal" href="using.html#repo-using-private-packages"><span class="std std-ref">private packages</span></a> without an
    <a class="reference internal" href="managing-account.html#repo-using-tokens"><span class="std std-ref">access token</span></a>, upload your own or to share your
    packages, notebooks, environments and installers with others.</p>
    <ol class="arabic simple">
    <li>In the top search box, type part or all of the name of a file you
    are searching for and press Enter.</li>
    <li>Packages that match your search string are displayed. Click the
    name to see more information.</li>
    </ol>
    <img alt="../../../_images/anaconda-repository/2.24/anaconda-repo-search.png" src="../../../_images/anaconda-repository/2.24/anaconda-repo-search.png" />
    </div>
    <div class="section" id="refine-your-search-results">
    <h3>Refine your search results<a class="headerlink" href="#refine-your-search-results" title="Permalink to this headline">¶</a></h3>
    <p>You can filter search results using three filter controls:</p>
    <ul class="simple">
    <li>All packages, conda only or PyPI only</li>
    <li>All types, Public and/or Private (only available if you are logged
    in)</li>
    <li>Platforms: All, Source, Linux-32, Linux-64, Noarch, OSX-64, Win-32,
    Win-64.</li>
    </ul>
    <p>&#8220;Source&#8221; packages are source code only, not yet built for any
    specific platform.</p>
    <p>&#8220;Noarch&#8221; packages are built to work on all platforms.</p>
    </div>
    <div class="section" id="download-and-install-a-package">
    <h3>Download and install a package<a class="headerlink" href="#download-and-install-a-package" title="Permalink to this headline">¶</a></h3>
    <p>You can download and install packages using Anaconda Navigator,
    the graphical user interface for Anaconda Repository.
    Advanced users may prefer a terminal window or command prompt.
    Instructions are included for both.</p>
    <p><strong>Using Anaconda Navigator</strong></p>
    <p>Anaconda Navigator is automatically installed when you install
    Anaconda. Start <a class="reference internal" href="../../anaconda/navigator.html"><span class="doc">Navigator</span></a> by clicking
    its program icon on your desktop or in your programs menu.</p>
    <p>First, set up Navigator to search your local Anaconda Repository. From
    the top menu bar, select Preferences. In the &#8220;Anaconda API domain&#8221; box,
    enter the address of your local Anaconda Repository and click the
    Apply button:</p>
    <img alt="../../../_images/anaconda-repository/2.24/anaconda-repo-local.png" src="../../../_images/anaconda-repository/2.24/anaconda-repo-local.png" />
    <p>NOTE: If your organization does not use HTTPS, type HTTP and un-check
    the next box, &#8220;Enable SSL verification.&#8221;</p>
    <p>NOTE:  If your organization uses subdomains, enter the address like
    this: <code class="docutils literal"><span class="pre">https://api.&lt;your-anaconda-repo&gt;:8080</span></code>. If that fails, please
    check with your Administrator.</p>
    <p>Next, sign Navigator into your local Anaconda Cloud (Anaconda Repository)
    so you can search for packages marked as private. Click the top right
    &#8220;Sign in to Anaconda Cloud&#8221; button and enter your Anaconda Repository
    Username and Password, then click the Apply button:</p>
    <img alt="../../../_images/anaconda-repository/2.24/anaconda-repo-navigator-signin.png" src="../../../_images/anaconda-repository/2.24/anaconda-repo-navigator-signin.png" />
    <p>Download and install a package into its own environment
    from your Environments tab: from the far right &#8220;Search packages&#8221;
    box enter the name of the package. Be sure to select either &#8220;not
    installed&#8221; or &#8220;all&#8221; from the drop-down menu, then click the Search
    button. Check the checkbox of the package you want to install and
    click the Apply button. See  <a class="reference internal" href="../../anaconda/navigator.html"><span class="doc">Navigator</span></a> for
    more detailed information.</p>
    <p><strong>Using conda in a terminal window or command prompt</strong></p>
    <p>After you have located a package on Anaconda Repository and clicked on
    the name, the detail page displays specific install instructions for the
    current operating system. Copy and paste the full command into your
    terminal window.</p>
    <p>NOTE: For the following examples to work, you need to have
    <a class="reference external" href="http://conda.pydata.org/docs/download.html">conda</a> downloaded and
    installed.</p>
    <p>EXAMPLE: To download and install a package with conda, run:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">username</span> <span class="n">packagename</span>
    </pre></div>
    </div>
    <p>TIP: Conda automatically expands the &#8220;username&#8221; to a URL such as
    <code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/username</span></code>.</p>
    </div>
    </div>
    <div class="section" id="build-and-upload-new-packages">
    <span id="repo-quickstart-build-upload"></span><h2>Build and upload new packages<a class="headerlink" href="#build-and-upload-new-packages" title="Permalink to this headline">¶</a></h2>
    <p>Building and uploading new packages is optional for advanced users who
    are comfortable using a Terminal application.</p>
    <p>To build and upload packages, install the Anaconda Client command line
    interface (CLI). Open a Terminal window and enter:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">anaconda</span><span class="o">-</span><span class="n">client</span>
    </pre></div>
    </div>
    <p>Next, still in your Terminal window, log into your Anaconda
    Repository account:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">login</span>
    </pre></div>
    </div>
    <p>At the prompt, enter your Anaconda Repository username and password.</p>
    <p>Next, choose the package you would like to build. For this quickstart,
    you can download our public test package:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">Anaconda</span><span class="o">-</span><span class="n">Server</span><span class="o">/</span><span class="n">anaconda</span><span class="o">-</span><span class="n">client</span>
    <span class="n">cd</span> <span class="n">anaconda</span><span class="o">-</span><span class="n">client</span><span class="o">/</span><span class="n">example</span><span class="o">-</span><span class="n">packages</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span>
    </pre></div>
    </div>
    <p>To build your test package, first install conda-build and turn off
    automatic anaconda-client uploading, then run the conda build command:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">conda</span><span class="o">-</span><span class="n">build</span>
    <span class="n">conda</span> <span class="n">config</span> <span class="o">--</span><span class="nb">set</span> <span class="n">anaconda_upload</span> <span class="n">no</span>
    <span class="n">conda</span> <span class="n">build</span> <span class="o">.</span>
    </pre></div>
    </div>
    <p>Check your path to where the newly-built file was placed so you can use
    it in the next step:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">build</span> <span class="o">.</span> <span class="o">--</span><span class="n">output</span>
    </pre></div>
    </div>
    <p>Finally, still in your Terminal window, if you haven&#8217;t already log
    into your Anaconda Repository account, then upload your newly-built
    test package:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">login</span>
    <span class="n">anaconda</span> <span class="n">upload</span> <span class="o">/</span><span class="n">your</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">conda</span><span class="o">-</span><span class="n">package</span><span class="o">.</span><span class="n">tar</span><span class="o">.</span><span class="n">bz2</span>
    </pre></div>
    </div>
    <p>For detailed information, see the <a class="reference internal" href="using.html#repo-using-conda-packages"><span class="std std-ref">Conda packages</span></a> section.</p>
    </div>
    <div class="section" id="share-notebooks">
    <h2>Share notebooks<a class="headerlink" href="#share-notebooks" title="Permalink to this headline">¶</a></h2>
    <p>Upload a <a class="reference external" href="http://jupyter.org/">Jupyter notebook</a> (formerly IPython
    notebook) to Anaconda Repository:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">upload</span> <span class="n">my</span><span class="o">-</span><span class="n">notebook</span><span class="o">.</span><span class="n">ipynb</span>
    </pre></div>
    </div>
    <p>An HTML version of the notebook will be located at:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">notebooks</span><span class="o">.</span><span class="n">anaconda</span><span class="o">.</span><span class="n">org</span><span class="o">/&lt;</span><span class="n">USERNAME</span><span class="o">&gt;/</span><span class="n">my</span><span class="o">-</span><span class="n">notebook</span>
    </pre></div>
    </div>
    <p>Anyone who has access to Anaconda Repository can download it:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">download</span> <span class="n">username</span><span class="o">/</span><span class="n">my</span><span class="o">-</span><span class="n">notebook</span>
    </pre></div>
    </div>
    </div>
    <div class="section" id="share-environments">
    <h2>Share environments<a class="headerlink" href="#share-environments" title="Permalink to this headline">¶</a></h2>
    <p>Save a <a class="reference external" href="http://conda.pydata.org/docs/using/envs.html">conda
    environment</a> and upload
    it to Anaconda Repository:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">env</span> <span class="n">export</span> <span class="o">-</span><span class="n">n</span> <span class="n">my</span><span class="o">-</span><span class="n">environment</span> <span class="o">-</span><span class="n">f</span> <span class="n">my</span><span class="o">-</span><span class="n">environment</span><span class="o">.</span><span class="n">yml</span>
    <span class="n">conda</span> <span class="n">env</span> <span class="n">upload</span> <span class="o">-</span><span class="n">f</span> <span class="n">my</span><span class="o">-</span><span class="n">environment</span><span class="o">.</span><span class="n">yml</span>
    </pre></div>
    </div>
    <p>A list of your uploaded environments is located at:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">envs</span><span class="o">.&lt;</span><span class="n">anaconda</span><span class="o">-</span><span class="n">repo</span><span class="o">-</span><span class="n">name</span><span class="o">&gt;/&lt;</span><span class="n">USERNAME</span><span class="o">&gt;</span>
    </pre></div>
    </div>
    <p>Anyone can download and install your environment from Anaconda Repository:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">env</span> <span class="n">create</span> <span class="n">user</span><span class="o">/</span><span class="n">my</span><span class="o">-</span><span class="n">environment</span>
    <span class="n">source</span> <span class="n">activate</span> <span class="n">my</span><span class="o">-</span><span class="n">environment</span>
    </pre></div>
    </div>
    </div>
