Skip to content

Commit

Permalink
DOC: Rework installation for newer versions
Browse files Browse the repository at this point in the history
  • Loading branch information
HaoZeke committed Aug 19, 2023
1 parent ae5b9c3 commit 2ca5795
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions docs/source/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,30 @@ install git+https://github.com/airspeed-velocity/asv``.

The requirements should be automatically installed. If they aren't
installed automatically, for example due to networking restrictions,
the requirements are:
the ``python`` requirements are as noted in the ``pyproject.toml``.

- `six <http://pythonhosted.org/six/>`__, 1.4 or later
For managing the environments, one of the following packages is required:

and one of the following:
- `libmambapy <https://mamba.readthedocs.io/en/latest/python_api.html>`__,
which is typically part of ``mamba``

- `virtualenv <http://virtualenv.org/>`__, 1.10 or later (it is required
also on Python 3, where virtualenv is included as venv, since
venv is not compatible with other versions of Python).

Note that virtualenv 1.11.0 will not work, as it contains a bug in
setuptools that prevents its installation in a clean virtual
environment.
- `virtualenv <http://virtualenv.org/>`__, which is required since
venv is not compatible with other versions of Python.

- An `anaconda <https://store.continuum.io/cshop/anaconda/>`__ or
`miniconda <http://conda.pydata.org/miniconda.html>`__
installation, with the ``conda`` command available on your path.

.. note::

Anaconda or miniconda is preferred if the dependencies of your
project involve a lot of compiled C/C++ extensions and are
available in the ``conda`` repository, since ``conda`` will be able
to fetch precompiled binaries for these dependencies in many cases.
Using ``virtualenv``, dependencies without precompiled wheels
usually have to be compiled every time the environments are set up.
``libmambapy`` is the fastest for situations where non-pythonic
dependencies are required. Anaconda or miniconda is slower but
still preferred if the project involves a lot of compiled C/C++
extensions and are available in the ``conda`` repository, since
``conda`` will be able to fetch precompiled binaries for these
dependencies in many cases. Using ``virtualenv``, dependencies
without precompiled wheels usually have to be compiled every
time the environments are set up.

Optional optimization
---------------------
Expand Down

0 comments on commit 2ca5795

Please sign in to comment.