====================
Reference (AER 2.28)
====================

.. raw:: html

    <div class="section" id="how-to">
    <h2>How To...<a class="headerlink" href="#how-to" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="use-packages">
    <h3>Use packages<a class="headerlink" href="#use-packages" title="Permalink to this headline">¶</a></h3>
    <div class="section" id="find-a-package">
    <h4>Find a package<a class="headerlink" href="#find-a-package" title="Permalink to this headline">¶</a></h4>
    <p>In your browser, you can search Anaconda Repository for packages
    by package name. From the search box in the top navigation bar
    of any page, enter the package name. You can filter your searches
    to specify only conda or PyPI packages, and you can sort results
    by number of favorites or number of downloads by clicking the
    search results column heading.</p>
    </div>
    <div class="section" id="download-and-install-a-package-from-anaconda-repository">
    <h4>Download and install a package from Anaconda Repository<a class="headerlink" href="#download-and-install-a-package-from-anaconda-repository" title="Permalink to this headline">¶</a></h4>
    <p>To install a conda package, in your terminal window run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>conda install -c username packagename
    </pre></div>
    </div>
    <p>Conda expands &#8220;username&#8221; to a URL such as
    <code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/username</span></code>
    based on the settings in the .condarc file.</p>
    </div>
    <div class="section" id="download-and-install-a-pypi-package-from-anaconda-repository">
    <h4>Download and install a PyPI package from Anaconda Repository<a class="headerlink" href="#download-and-install-a-pypi-package-from-anaconda-repository" title="Permalink to this headline">¶</a></h4>
    <p>To install a PyPI package, in your terminal window run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>pip install --index-url pypi.anaconda.org/USERNAME/simple packagename
    </pre></div>
    </div>
    </div>
    </div>
    <div class="section" id="use-the-anaconda-client-cli">
    <h3>Use the anaconda-client CLI<a class="headerlink" href="#use-the-anaconda-client-cli" title="Permalink to this headline">¶</a></h3>
    <div class="section" id="install-anaconda-client">
    <h4>Install anaconda-client<a class="headerlink" href="#install-anaconda-client" title="Permalink to this headline">¶</a></h4>
    <p>The anaconda-client command line interface (CLI) is available via conda
    or pip. See <a class="reference internal" href="using.html#repo-installing-anaconda-client"><span>installation and setup
    instructions</span></a>.</p>
    </div>
    <div class="section" id="find-my-anaconda-client-login-credentials">
    <h4>Find my anaconda-client login credentials<a class="headerlink" href="#find-my-anaconda-client-login-credentials" title="Permalink to this headline">¶</a></h4>
    <p>Your login credentials for anaconda-client are the same as those you used
    to create an account on Anaconda Repository. For help, in a browser
    window, navigate to your Anaconda Repository Sign In tab and click
    &#8220;forgot password.&#8221;</p>
    </div>
    <div class="section" id="log-into-anaconda-client">
    <h4>Log into anaconda-client<a class="headerlink" href="#log-into-anaconda-client" title="Permalink to this headline">¶</a></h4>
    <p>After you have downloaded and configured anaconda-client, open a
    terminal window and run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>anaconda login
    </pre></div>
    </div>
    </div>
    <div class="section" id="see-a-list-of-anaconda-client-commands">
    <h4>See a list of anaconda-client commands<a class="headerlink" href="#see-a-list-of-anaconda-client-commands" title="Permalink to this headline">¶</a></h4>
    <p>From a terminal window, run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="o">--</span><span class="n">help</span>
    </pre></div>
    </div>
    </div>
    <div class="section" id="find-out-more-about-an-anaconda-client-command">
    <h4>Find out more about an anaconda-client command<a class="headerlink" href="#find-out-more-about-an-anaconda-client-command" title="Permalink to this headline">¶</a></h4>
    <p>From a terminal window, run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>anaconda COMMANDNAME -h
    </pre></div>
    </div>
    </div>
    <div class="section" id="see-a-list-of-all-available-anaconda-client-configuration-files">
    <h4>See a list of all available anaconda-client configuration files<a class="headerlink" href="#see-a-list-of-all-available-anaconda-client-configuration-files" title="Permalink to this headline">¶</a></h4>
    <p>From a terminal window, run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>anaconda config --files
    </pre></div>
    </div>
    </div>
    <div class="section" id="see-a-list-of-all-of-my-anaconda-client-configuration-variables">
    <h4>See a list of all of my anaconda-client configuration variables<a class="headerlink" href="#see-a-list-of-all-of-my-anaconda-client-configuration-variables" title="Permalink to this headline">¶</a></h4>
    <p>From a terminal window, run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>anaconda config --show
    </pre></div>
    </div>
    </div>
    <div class="section" id="find-out-more-about-the-anaconda-client">
    <h4>Find out more about the anaconda-client<a class="headerlink" href="#find-out-more-about-the-anaconda-client" title="Permalink to this headline">¶</a></h4>
    <p>If you have a question that you cannot answer using the help command or
    documentation, contact your site administrator who has access to
    enterprise priority support.</p>
    </div>
    </div>
    <div class="section" id="build-packages">
    <h3>Build packages<a class="headerlink" href="#build-packages" title="Permalink to this headline">¶</a></h3>
    <div class="section" id="build-and-upload-a-package">
    <h4>Build and upload a package<a class="headerlink" href="#build-and-upload-a-package" title="Permalink to this headline">¶</a></h4>
    <p>For a quick run-through, try the Quickstart <a class="reference internal" href="quickstart.html#repo-quickstart-build-upload"><span>build guide
    section</span></a>.</p>
    </div>
    <div class="section" id="test-a-built-package">
    <h4>Test a built package<a class="headerlink" href="#test-a-built-package" title="Permalink to this headline">¶</a></h4>
    <p>Specify the &#8216;&#8211;use-local&#8217; option. For example:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>conda create --use-local -n test PACKAGENAME
    </pre></div>
    </div>
    </div>
    <div class="section" id="upload-a-package-to-anaconda-repository">
    <h4>Upload a package to Anaconda Repository<a class="headerlink" href="#upload-a-package-to-anaconda-repository" title="Permalink to this headline">¶</a></h4>
    <p>In a terminal window, run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>anaconda upload PACKAGENAME
    </pre></div>
    </div>
    </div>
    <div class="section" id="find-help-uploading-packages">
    <h4>Find help uploading packages<a class="headerlink" href="#find-help-uploading-packages" title="Permalink to this headline">¶</a></h4>
    <p>For a complete list of upload options, including specifying a package&#8217;s
    channel, label, availability to other users, and metadata, in a terminal
    window, run:</p>
    <div class="highlight-python"><div class="highlight"><pre><span></span>anaconda upload -h
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    <div class="section" id="faq">
    <h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="general-questions">
    <h3>General Questions<a class="headerlink" href="#general-questions" title="Permalink to this headline">¶</a></h3>
    <div class="section" id="what-is-anaconda-repository">
    <h4>What is Anaconda Repository?<a class="headerlink" href="#what-is-anaconda-repository" title="Permalink to this headline">¶</a></h4>
    <p>Anaconda Repository is private package management server software. Anaconda
    Repository makes it easy to find, access, store and share public and
    private notebooks, environments, and conda and PyPI packages, and
    to keep up with updates made to the packages and environments you need.</p>
    </div>
    <div class="section" id="what-kind-of-packages-does-anaconda-repository-support">
    <h4>What kind of packages does Anaconda Repository support?<a class="headerlink" href="#what-kind-of-packages-does-anaconda-repository-support" title="Permalink to this headline">¶</a></h4>
    <p>Anaconda Repository supports any type of package. It is primarily used
    for conda, PyPI and R packages, as well as notebooks and environments.</p>
    </div>
    <div class="section" id="what-is-continuum-analytics">
    <h4>What is Continuum Analytics?<a class="headerlink" href="#what-is-continuum-analytics" title="Permalink to this headline">¶</a></h4>
    <p>Continuum Analytics is a software development and consulting company of
    passionate open source advocates based in Austin, Texas, USA. We are
    committed to the open source community. We created the Anaconda Python
    distribution and contribute to many other open source-based data
    analytics tools. You can find out more about us
    <a class="reference external" href="http://continuum.io/our-story">here</a>.</p>
    </div>
    <div class="section" id="how-do-i-get-started-with-anaconda-repository">
    <h4>How do I get started with Anaconda Repository?<a class="headerlink" href="#how-do-i-get-started-with-anaconda-repository" title="Permalink to this headline">¶</a></h4>
    <p>If you have access to Anaconda Repository, you can search,
    download and install hundreds of &#8220;public&#8221; packages without
    even having an account.</p>
    <p>If you wish to upload packages to Anaconda Repository, you
    will need to sign up for an Anaconda Repository
    account. See our <a class="reference internal" href="using.html"><em>Using Anaconda Repository</em></a> section for more help or ask
    your administrator.</p>
    </div>
    <div class="section" id="what-is-an-organization-account-and-how-is-it-different-from-an-individual-account">
    <h4>What is an organization account, and how is it different from an individual account?<a class="headerlink" href="#what-is-an-organization-account-and-how-is-it-different-from-an-individual-account" title="Permalink to this headline">¶</a></h4>
    <p>An organization account allows multiple individual users to administer
    packages and have more control of package access by other users. An
    individual account is for use by one person.</p>
    </div>
    <div class="section" id="who-can-upload-packages-to-an-organization">
    <h4>Who can upload packages to an organization?<a class="headerlink" href="#who-can-upload-packages-to-an-organization" title="Permalink to this headline">¶</a></h4>
    <p>Only users who are co-owners of the organization may upload packages to that
    organization. Administrators who are not co-owners cannot upload packages to
    the organization. Users who are members of groups with Read/Write access but
    who are not co-owners cannot upload packages to the organization.</p>
    </div>
    </div>
    </div>
    <div class="section" id="glossary">
    <h2>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="anaconda">
    <h3>Anaconda<a class="headerlink" href="#anaconda" title="Permalink to this headline">¶</a></h3>
    <p>An easy-to-install, free collection of Open Source packages, including
    Python and the conda package manager. Over
    150 packages are installed with Anaconda. The Anaconda Repository
    contains over 250 additional Open Source packages that can be installed
    or updated after installing Anaconda with the
    <code class="docutils literal"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">PACKAGENAME</span></code> command.</p>
    </div>
    <div class="section" id="anaconda-repository">
    <h3>Anaconda Repository<a class="headerlink" href="#anaconda-repository" title="Permalink to this headline">¶</a></h3>
    <p>Anaconda Repository hosts hundreds of useful Python packages, notebooks and
    environments for a wide variety of applications. You don&#8217;t need to have
    an Anaconda Repository account, or to be logged in, to search for
    packages, download and install them.</p>
    </div>
    <div class="section" id="anaconda-client-cli">
    <h3>Anaconda-Client CLI<a class="headerlink" href="#anaconda-client-cli" title="Permalink to this headline">¶</a></h3>
    <p>The Anaconda-Client command line interface (CLI) allows you to log into
    Anaconda Repository directly from your terminal window and manage your
    account. It is not necessary for
    downloading or installing packages from Anaconda Repository.</p>
    </div>
    <div class="section" id="labels">
    <h3>Labels<a class="headerlink" href="#labels" title="Permalink to this headline">¶</a></h3>
    <p>The URLs on Anaconda Repository where conda looks for packages. Using the
    Anaconda-Client CLI in a terminal window, package developers can
    create additional labels
    such as development (labels/dev) test (labels/test) or other labels
    which will be searched only if the user specifies the label.</p>
    <p><code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/travis/labels/main</span></code> - the label searched by
    default</p>
    <p><code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/travis</span></code> - same as default label with &#8220;main&#8221;
    implicit</p>
    <p><code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/travis/labels/dev</span></code> - contains the packages
    in development</p>
    <p><code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/travis/labels/test</span></code> - contains packages ready to
    test</p>
    <p><code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/travis/labels/any-custom-label</span></code> - any label you
    wish to use.</p>
    </div>
    <div class="section" id="conda">
    <h3>Conda<a class="headerlink" href="#conda" title="Permalink to this headline">¶</a></h3>
    <p>The conda package manager and environment manager program that installs
    and updates packages and their dependencies, and lets you easily switch
    between environments on your local computer.</p>
    </div>
    <div class="section" id="conda-build">
    <h3>Conda-Build<a class="headerlink" href="#conda-build" title="Permalink to this headline">¶</a></h3>
    <p>The command line interface that lets you build packages for your local
    operating system.</p>
    </div>
    <div class="section" id="conda-package">
    <h3>Conda package<a class="headerlink" href="#conda-package" title="Permalink to this headline">¶</a></h3>
    <p>A tarball (compressed file) containing system-level libraries, Python
    modules, executable programs, or other components.</p>
    </div>
    <div class="section" id="miniconda">
    <h3>Miniconda<a class="headerlink" href="#miniconda" title="Permalink to this headline">¶</a></h3>
    <p>A minimal installer for conda. Like Anaconda, Miniconda is a software
    package that includes the conda package manager and Python and its
    dependencies, but does not include any other packages. Once conda is
    installed by installing either Anaconda or Miniconda, other software
    packages may be installed directly from the command line with &#8216;conda
    install&#8217;. See also Anaconda and conda.</p>
    </div>
    <div class="section" id="noarch-package">
    <h3>Noarch package<a class="headerlink" href="#noarch-package" title="Permalink to this headline">¶</a></h3>
    <p>A conda package that contains nothing specific to any system
    architecture, so it may be installed on any system. When conda does a
    search for packages on any system in a channel, conda always checks both
    the system-specific subdirectory, for example, <code class="docutils literal"><span class="pre">linux-64</span></code> <em>and</em> the
    <code class="docutils literal"><span class="pre">noarch</span></code> directory.</p>
    </div>
    <div class="section" id="onsite">
    <h3>OnSite<a class="headerlink" href="#onsite" title="Permalink to this headline">¶</a></h3>
    <p>Anaconda Repository is powered by Anaconda Server by Continuum Analytics. Run
    your own Anaconda server behind firewalls or in air-gapped environments.
    Contact <a class="reference external" href="mailto:sales&#37;&#52;&#48;continuum&#46;io">sales<span>&#64;</span>continuum<span>&#46;</span>io</a> for more
    information.</p>
    </div>
    <div class="section" id="organization">
    <h3>Organization<a class="headerlink" href="#organization" title="Permalink to this headline">¶</a></h3>
    <p>An organization account is a type of account on Anaconda Repository that
    allows multiple individual users to administer packages and control
    package access to different user groups. It also includes a large amount
    of storage space.</p>
    </div>
    <div class="section" id="repository">
    <h3>Repository<a class="headerlink" href="#repository" title="Permalink to this headline">¶</a></h3>
    <p>A storage location from which software packages may be retrieved and
    installed on a computer.</p>
    </div>
    <div class="section" id="source-package">
    <h3>Source package<a class="headerlink" href="#source-package" title="Permalink to this headline">¶</a></h3>
    <p>&#8220;Source&#8221; packages are source code only, not yet built for any specific
    platform, and might be compatible with all, some, or only one of the
    platforms.</p>
    </div>
    <div class="section" id="token">
    <span id="repo-reference-token"></span><h3>Token<a class="headerlink" href="#token" title="Permalink to this headline">¶</a></h3>
    <p>A token (or authentication token) is the mechanism by which anonymous
    users can download private packages without using an Anaconda Repository
    account. It is an alpha-numeric code that is inserted into a URL that
    allows access by anyone who has the URL. You can use anaconda-client to
    generate new tokens to give other users specifically scoped access to
    packages and collections.</p>
    </div>
    <div class="section" id="user-namespace">
    <h3>User Namespace<a class="headerlink" href="#user-namespace" title="Permalink to this headline">¶</a></h3>
    <p>The part of Anaconda Repository where a user or organization may host
    packages. For example, the <em>user namespace</em> <code class="docutils literal"><span class="pre">https://&lt;your-anaconda-repo&gt;/travis</span></code>
    contains packages that were uploaded and shared by the user named
    Travis.</p>
    </div>
    </div>
