Skip to content

Commit 30539eb

Browse files
committed
DOC: Improve install instructions in README.rst
The README now notes the current supported Python versions, and refers the reader to zipline.io for details. (The README's details had become out of sync with zipline.io, which also needs to be redeployed to bring in some recent changes.) Resolves #2571.
1 parent bbf9221 commit 30539eb

File tree

1 file changed

+7
-54
lines changed

1 file changed

+7
-54
lines changed

README.rst

Lines changed: 7 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -40,62 +40,15 @@ Features
4040
Installation
4141
============
4242

43-
Installing With ``pip``
44-
-----------------------
43+
Zipline currently supports Python 2.7 and Python 3.5, and may be installed via
44+
either pip or conda.
4545

46-
Assuming you have all required (see note below) non-Python dependencies, you
47-
can install Zipline with ``pip`` via:
46+
**Note:** Installing Zipline is slightly more involved than the average Python
47+
package. See the full `Zipline Install Documentation`_ for detailed
48+
instructions.
4849

49-
.. code-block:: bash
50-
51-
$ pip install zipline
52-
53-
**Note:** Installing Zipline via ``pip`` is slightly more involved than the
54-
average Python package. Simply running ``pip install zipline`` will likely
55-
fail if you've never installed any scientific Python packages before.
56-
57-
There are two reasons for the additional complexity:
58-
59-
1. Zipline ships several C extensions that require access to the CPython C API.
60-
In order to build the C extensions, ``pip`` needs access to the CPython
61-
header files for your Python installation.
62-
63-
2. Zipline depends on `numpy <https://www.numpy.org/>`_, the core library for
64-
numerical array computing in Python. Numpy depends on having the `LAPACK
65-
<https://www.netlib.org/lapack/>`_ linear algebra routines available.
66-
67-
Because LAPACK and the CPython headers are binary dependencies, the correct way
68-
to install them varies from platform to platform. On Linux, users generally
69-
acquire these dependencies via a package manager like ``apt``, ``yum``, or
70-
``pacman``. On OSX, `Homebrew <https://brew.sh/>`_ is a popular choice
71-
providing similar functionality.
72-
73-
See the full `Zipline Install Documentation`_ for more information on acquiring
74-
binary dependencies for your specific platform.
75-
76-
conda
77-
-----
78-
79-
Another way to install Zipline is via the ``conda`` package manager, which
80-
comes as part of `Anaconda <https://www.anaconda.com/distribution/>`_ or can be
81-
installed via ``pip install conda``.
82-
83-
Once set up, you can install Zipline from our ``Quantopian`` channel:
84-
85-
.. code-block:: bash
86-
87-
$ conda install -c Quantopian zipline
88-
89-
Currently supported platforms include:
90-
91-
- GNU/Linux 64-bit
92-
- OSX 64-bit
93-
- Windows 64-bit
94-
95-
.. note::
96-
97-
Windows 32-bit may work; however, it is not currently included in
98-
continuous integration tests.
50+
For a development installation (used to develop Zipline itself), create and
51+
activate a virtualenv, then run the ``etc/dev-install`` script.
9952

10053
Quickstart
10154
==========

0 commit comments

Comments
 (0)