README.rst

@@ -48,43 +48,69 @@ images and transformation between them.
 How to obtain the dataset
 -------------------------
 
-This repository contains metadata and information on the identity of all
+This repository is a `DataLad <https://www.datalad.org/>`__ dataset. It provides
-included files. However, the actual content of the (sometime large) data
+fine-grained data access down to the level of individual files, and allows for
-files is stored elsewhere. To obtain any dataset component, git-annex_ is
+tracking future updates up to the level of single files. In order to use
-required in addition to Git_.
+this repository for data retrieval, `DataLad <https://www.datalad.org>`_ is
+required. It is a free and open source command line tool, available for all
+major operating systems, and builds up on Git and `git-annex
+<https://git-annex.branchable.com>`__ to allow sharing, synchronizing, and
+version controlling collections of large files. You can find information on
+how to install DataLad at `handbook.datalad.org/en/latest/intro/installation.html
+<http://handbook.datalad.org/en/latest/intro/installation.html>`_.
 
-1. Clone this repository to the desired location.
+Get the dataset
-2. Enter the directory with the local clone and run::
+^^^^^^^^^^^^^^^
 
-     git annex init
+A DataLad dataset can be ``cloned`` by running::
 
-   Older versions of git-annex may require you to run the following
+   datalad clone <url>
-   command immediately afterwards::
 
-     git annex enableremote mddatasrc
+Once a dataset is cloned, it is a light-weight directory on your local machine.
+At this point, it contains only small metadata and information on the
+identity of the files in the dataset, but not actual *content* of the
+(sometimes large) data files.
 
-Now any desired dataset component can be obtained by using the ``git annex get``
+Retrieve dataset content
-command. To obtain the entire dataset content run::
+^^^^^^^^^^^^^^^^^^^^^^^^
 
-     git annex get .
+After cloning a dataset, you can retrieve file contents by running::
 
+   datalad get <path/to/directory/or/file>
 
-Keep data up-to-date
+This command will trigger a download of the files, directories, or
---------------------
+subdatasets you have specified.
 
-If updates to this dataset are made in the future, update any local clone by
+DataLad datasets can contain other datasets, so called *subdatasets*. If you
-running::
+clone the top-level dataset, subdatasets do not yet contain metadata and
+information on the identity of files, but appear to be empty directories. In
+order to retrieve file availability metadata in subdatasets, run::
 
-     git pull
+   datalad get -n <path/to/subdataset>
 
-followed by::
+Afterwards, you can browse the retrieved metadata to find out about
+subdataset contents, and retrieve individual files with ``datalad get``. If you
+use ``datalad get <path/to/subdataset>``, all contents of the subdataset will
+be downloaded at once.
 
-     git annex get .
+Stay up-to-date
+^^^^^^^^^^^^^^^
 
-to fetch all new files.
+DataLad datasets can be updated. The command ``datalad update`` will *fetch*
+updates and store them on a different branch (by default
+``remotes/origin/master``). Running::
 
+   datalad update --merge
 
+will *pull* available updates and integrate them in one go.
 
+More information
+^^^^^^^^^^^^^^^^
+
+More information on DataLad and how to use it can be found in the DataLad Handbook at
+`handbook.datalad.org <http://handbook.datalad.org/en/latest/index.html>`_. The
+chapter "DataLad datasets" can help you to familiarize yourself with the
+concept of a dataset.
 
 .. _Git: http://www.git-scm.com