==========
Quickstart
==========

Find, download and install packages
===================================

Search for a package
~~~~~~~~~~~~~~~~~~~~

You don'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. 

You do need an account to access
:ref:`private packages <repo-using-private-packages>` without an
:ref:`access token <repo-using-tokens>`, upload your own or to share your 
packages, notebooks, environments and installers with others.

#. In the top search box, type part or all of the name of a file you
   are searching for and press Enter.
#. Packages that match your search string are displayed. Click the
   name to see more information.
   
.. image:: /img/anaconda-repo-search.png


Refine your search results
~~~~~~~~~~~~~~~~~~~~~~~~~~

You can filter search results using three filter controls:

-  All packages, conda only or PyPI only
-  All types, Public and/or Private (only available if you are logged
   in)
-  Platforms: All, Source, Linux-32, Linux-64, Noarch, OSX-64, Win-32,
   Win-64.

"Source" packages are source code only, not yet built for any
specific platform.

"Noarch" packages are built to work on all platforms.


Download and install a package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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.

**Using Anaconda Navigator**

Anaconda Navigator is automatically installed when you install 
Anaconda. Start :doc:`Navigator </anaconda/navigator/index>` by clicking 
its program icon on your desktop or in your programs menu.  

First, set up Navigator to search your local Anaconda Repository. From 
the top menu bar, select Preferences. In the "Anaconda API domain" box, 
enter the address of your local Anaconda Repository and click the 
Apply button: 

.. image:: /img/anaconda-repo-local.png

NOTE: If your organization does not use HTTPS, type HTTP and un-check 
the next box, "Enable SSL verification."

NOTE:  If your organization uses subdomains, enter the address like 
this: ``https://api.<your-anaconda-repo>:8080``. If that fails, please 
check with your Administrator. 

Next, sign Navigator into your local Anaconda Cloud (Anaconda Repository) 
so you can search for packages marked as private. Click the top right 
"Sign in to Anaconda Cloud" button and enter your Anaconda Repository 
Username and Password, then click the Apply button:

.. image:: /img/anaconda-repo-navigator-signin.png

Download and install a package into its own environment 
from your Environments tab: from the far right "Search packages" 
box enter the name of the package. Be sure to select either "not 
installed" or "all" 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  :doc:`Navigator </anaconda/navigator/index>` for 
more detailed information.

**Using conda in a terminal window or command prompt**

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.

NOTE: For the following examples to work, you need to have
`conda <http://conda.pydata.org/docs/download.html>`_ downloaded and
installed.

EXAMPLE: To download and install a package with conda, run::

      conda install -c username packagename

TIP: Conda automatically expands the "username" to a URL such as 
``https://<your-anaconda-repo>/username``.


.. _repo-quickstart-build-upload:

Build and upload new packages
=============================

Building and uploading new packages is optional for advanced users who 
are comfortable using a Terminal application.

To build and upload packages, install the Anaconda Client command line
interface (CLI). Open a Terminal window and enter::

      conda install anaconda-client

Next, still in your Terminal window, log into your Anaconda 
Repository account::

      anaconda login

At the prompt, enter your Anaconda Repository username and password.

Next, choose the package you would like to build. For this quickstart,
you can download our public test package::

    git clone https://github.com/Anaconda-Server/anaconda-client
    cd anaconda-client/example-packages/conda/

To build your test package, first install conda-build and turn off
automatic anaconda-client uploading, then run the conda build command::

      conda install conda-build
      conda config --set anaconda_upload no
      conda build .

Check your path to where the newly-built file was placed so you can use
it in the next step::

      conda build . --output

Finally, still in your Terminal window, if you haven't already log 
into your Anaconda Repository account, then upload your newly-built 
test package::

      anaconda login
      anaconda upload /your/path/conda-package.tar.bz2

For detailed information, see the :ref:`repo-using-conda-packages` section.


Share notebooks
===============

Upload a `Jupyter notebook <http://jupyter.org/>`_ (formerly IPython
notebook) to Anaconda Repository::

    anaconda upload my-notebook.ipynb

An HTML version of the notebook will be located at::

    http://notebooks.anaconda.org/<USERNAME>/my-notebook

Anyone who has access to Anaconda Repository can download it::

    anaconda download username/my-notebook


Share environments
==================

Save a `conda
environment <http://conda.pydata.org/docs/using/envs.html>`_ and upload
it to Anaconda Repository::

    conda env export -n my-environment -f my-environment.yml
    conda env upload -f my-environment.yml

A list of your uploaded environments is located at::

    http://envs.<anaconda-repo-name>/<USERNAME>

Anyone can download and install your environment from Anaconda Repository::

    conda env create user/my-environment
    source activate my-environment
