Skip to content

Commit

Permalink
Merge pull request #337 from datalad-handbook/install12
Browse files Browse the repository at this point in the history
remove rc specification in installation
  • Loading branch information
adswa authored Jan 11, 2020
2 parents a5a58c6 + ef3a19c commit 22bfa1b
Showing 1 changed file with 9 additions and 31 deletions.
40 changes: 9 additions & 31 deletions docs/intro/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ Installation and configuration

.. note::

The handbook is written for DataLad version 0.12. Currently, the latest version available
via many package managers is 0.11. Therefore, the most convenient way to obtain a
suitable version of datalad is to install of the most recent 0.12 release candidate,
``datalad~=0.12.0rc6``, via ``pip`` or ``conda``. Until 0.12 is released, please use
``pip`` or ``conda``-based methods to install the release candidate.

The handbook is written for DataLad version 0.12.
If you already have DataLad installed but are unsure whether it is the correct
version, you can get information on your version of DataLad by typing
``datalad --version`` into your terminal.
Expand All @@ -22,8 +17,9 @@ The content in this chapter is largely based on the information given on the
`DataLad website <https://www.datalad.org/get_datalad.html>`_
and the `DataLad documentation <http://docs.datalad.org/en/latest/gettingstarted.html>`_.

Beyond DataLad itself, the installation requires Python, Pythons package manager ``pip``,
:term:`Git`, and :term:`git-annex`. The instructions below detail how to install
Beyond DataLad itself, the installation requires Python, :term:`Git`,
:term:`git-annex`, and potentially Pythons package manager ``pip``.
The instructions below detail how to install
each of these components for different common operating systems. Please
`file an issue <https://github.com/datalad-handbook/book/issues/new>`_
if you encounter problems.
Expand All @@ -40,11 +36,6 @@ exist, and they need to be installed separately, if needed.
Linux: (Neuro)Debian, Ubuntu, and similar systems
"""""""""""""""""""""""""""""""""""""""""""""""""

.. note::

Do not use this method at the current time. This note will be removed
once DataLad 0.12 has been released.

For Debian-based operating systems, the most convenient installation method
is to enable the `NeuroDebian <http://neuro.debian.net/>`_ repository.
If you are on a Debian-based system, but do not have the NeuroDebian repository
Expand Down Expand Up @@ -73,8 +64,6 @@ can be installed with `Miniconda <https://docs.conda.io/en/latest/miniconda.html
$ bash Miniconda3-latest-Linux-x86_64.sh
# acknowledge license, keep everything at default
$ conda install -c conda-forge datalad
# upgrade to the latest release candidate to match the requires of the book
$ conda install -c conda-forge/label/rc datalad
This should install :term:`Git`, :term:`git-annex`, and DataLad.
The installer automatically configures the shell to make conda-installed
Expand All @@ -101,7 +90,7 @@ manager ``pip`` as described below. ``pip`` should already be installed by
default. Recent macOS versions may have ``pip3`` instead of ``pip`` -- use
:term:`tab completion` to find out which is installed. If it is ``pip3``, run::

$ pip3 install datalad~=0.12.0rc6
$ pip3 install datalad~=0.12

instead of the code snippets in the section below.

Expand All @@ -110,7 +99,7 @@ a user's home directory:

.. code-block:: bash
$ pip3 install --user datalad~=0.12.0rc6
$ pip3 install --user datalad~=0.12
.. findoutmore:: If something is not on PATH...
Expand Down Expand Up @@ -171,14 +160,14 @@ to automatically install DataLad and its software dependencies, type

.. code-block:: bash
$ pip install datalad~=0.12.0rc6
$ pip install datalad~=0.12
If this results in a ``permission denied`` error, install DataLad into
a user's home directory:

.. code-block:: bash
$ pip install --user datalad~=0.12.0rc6
$ pip install --user datalad~=0.12
In addition, it is necessary to have a current version of :term:`git-annex` installed which is
not set up automatically by using the ``pip`` method.
Expand Down Expand Up @@ -258,7 +247,7 @@ please `get in touch <https://github.com/datalad-handbook/book/issues/new>`_.

- ``pip`` was installed by ``miniconda``. In the ``Anaconda prompt``, run::

pip install datalad~=0.12.0rc6
pip install datalad~=0.12


.. container:: toggle
Expand All @@ -267,11 +256,6 @@ please `get in touch <https://github.com/datalad-handbook/book/issues/new>`_.

**2) Install within WSL**

.. note::

Do not use this method at the current time. This note will be removed
once DataLad 0.12 has been released.

The Windows Subsystem for Linux (WSL) allows Windows users to have full access
to a Linux distribution within Windows.
If you have always used Windows be prepared for some user experience changes when
Expand Down Expand Up @@ -376,12 +360,6 @@ please `get in touch <https://github.com/datalad-handbook/book/issues/new>`_.

**3) Install within WSL2**

.. note::

Do not use this method at the current time. This note will be removed
once DataLad 0.12 has been released.


The Windows Subsystem for Linux (WSL) allows Windows users to have full access
to a Linux distribution within Windows. The Windows Subsystem for Linux 2 (WSL2)
is the (currently pre-released) update to the WSL.
Expand Down

0 comments on commit 22bfa1b

Please sign in to comment.