the-littlest-jupyterhub/docs/howto/content/add-data.rst

.. _howto/content/add-data:

=============================
Adding data to the JupyterHub
=============================

This section covers how to add data to your JupyterHub either from the internet
or from your own machine. To learn how to **share data** that is already
on your JupyterHub, see :ref:`howto/content/share-data`.

.. note::

   When you add data using the methods on this page, you will **only add it
   to your user directory**. This is not a place that is accessible to others.
   For information on sharing this data with users on the JupyterHub, see
   :ref:`howto/content/share-data`.

Adding data from your local machine
===================================

The easiest way to add data to your JupyterHub is to use the "Upload" user
interface. To do so, follow these steps:

#. First, navigate to the Jupyter Notebook interface home page. You can do this
   by going to the URL ``<my-hub-url>/user/<my-username>/tree``.
#. Click the "Upload" button to open the file chooser window.

   .. image:: ../../images/content/upload-button.png
      :alt: The upload button in Jupyter.
#. Choose the file you wish to upload. You may select multiple files if you
   wish.
#. Click "Upload" for each file that you wish to upload.

   .. image:: ../../images/content/file-upload-buttons.png
      :alt: Multiple file upload buttons.
#. Wait for the progress bar to finish for each file. These files will now
   be on your JupyterHub, your home user's home directory.

To learn how to **share** this data with new users on the JupyterHub,
see :ref:`howto/content/share-data`.

Downloading data from the command line
======================================

If the data of interest is on the internet, you may also use code in order
to download it to your JupyterHub. There are several ways of doing this, so
we'll cover the simplest approach using the unix tool ``wget``.

#. Log in to your JupyterHub and open a terminal window.

   .. image:: ../../images/notebook/new-terminal-button.png
      :alt: New terminal button.

#. Use ``wget`` to download the file to your current directory in the terminal.

   .. code-block:: bash

      wget <MY-FILE-URL>

Example: Downloading the `gapminder <https://www.gapminder.org/>`_ dataset.
---------------------------------------------------------------------------

In this example we'll download the `gapminder <https://www.gapminder.org/>`_
dataset, which contains information about country GDP and live expectancy over
time. You can download it from your browser `at this link <https://swcarpentry.github.io/python-novice-gapminder/files/python-novice-gapminder-data.zip>`_.

#. Log in to your JupyterHub and open a terminal window.

   .. image:: ../../images/notebook/new-terminal-button.png
      :alt: New terminal button.

#. Use ``wget`` to download the gapminder dataset to your current directory in
   the terminal.

   .. code-block:: bash

      wget https://swcarpentry.github.io/python-novice-gapminder/files/python-novice-gapminder-data.zip

#. This is a **zip** file, so we'll need to download a unix tool called "unzip"
   in order to unzip it.

   .. code-block:: bash

      sudo -E apt-get install unzip

#. Finally, unzip the the file:

   unzip python-novice-gapminder-data.zip

#. Confirm that your data was unzipped. It could be in a folder called ``data/``.

To learn how to **share** this data with new users on the JupyterHub,
see :ref:`howto/content/share-data`.

.. TODO: Downloading data with the "download" module in Python? https://github.com/choldgraf/download