Skip to content

Commit 5c57be8

Browse files
author
llllllllll
committed
DOC: final cleanup
1 parent 7980e47 commit 5c57be8

File tree

2 files changed

+44
-60
lines changed

2 files changed

+44
-60
lines changed

README.rst

Lines changed: 42 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@ Zipline
88
|Coverage Status|
99
|Code quality|
1010

11-
Zipline is a Pythonic algorithmic trading library. The system is
12-
fundamentally event-driven and a close approximation of how live-trading
13-
systems operate.
11+
Zipline is a Pythonic algorithmic trading library. It is an event-driven
12+
system that supports both backtesting and live-trading.
1413

15-
Zipline is currently used in production as the backtesting engine
16-
powering `Quantopian Inc. <https://www.quantopian.com>`__ -- a free,
17-
community-centered platform that allows development and real-time
18-
backtesting of trading algorithms in the web browser.
14+
Zipline is currently used in production as the backtesting and live-trading
15+
engine powering `Quantopian <https://www.quantopian.com>`__ -- a free,
16+
community-centered, hosted platform for building and executing trading
17+
strategies.
1918

2019
`Join our
2120
community! <https://groups.google.com/forum/#!forum/zipline>`__
@@ -29,74 +28,57 @@ below.
2928
Features
3029
========
3130

32-
- Ease of use: Zipline tries to get out of your way so that you can
33-
focus on algorithm development. See below for a code example.
31+
- Ease of use: Zipline tries to get out of your way so that you can
32+
focus on algorithm development. See below for a code example.
33+
- Zipline comes "batteries included" as many common statistics like
34+
moving average and linear regression can be readily accessed from
35+
within a user-written algorithm.
36+
- Input of historical data and output of performance statistics are
37+
based on Pandas DataFrames to integrate nicely into the existing
38+
PyData eco-system.
39+
- Statistic and machine learning libraries like matplotlib, scipy,
40+
statsmodels, and sklearn support development, analysis, and
41+
visualization of state-of-the-art trading systems.
3442

35-
- Zipline comes "batteries included" as many common statistics like
36-
moving average and linear regression can be readily accessed from
37-
within a user-written algorithm.
43+
Installation
44+
============
45+
46+
pip
47+
---
3848

39-
- Input of historical data and output of performance statistics is
40-
based on Pandas DataFrames to integrate nicely into the existing
41-
Python eco-system.
49+
You can install Zipline via the ``pip`` command:
50+
::
4251

43-
- Statistic and machine learning libraries like matplotlib, scipy,
44-
statsmodels, and sklearn support development, analysis and
45-
visualization of state-of-the-art trading systems.
52+
$ pip install zipline
4653

47-
Installation
48-
============
4954

50-
The easiest way to install Zipline is via ``conda`` which comes as part
55+
conda
56+
-----
57+
58+
Another way to install Zipline is via ``conda`` which comes as part
5159
of `Anaconda <http://continuum.io/downloads>`__ or can be installed via
5260
``pip install conda``.
5361

54-
Once set up, you can install Zipline from our Quantopian channel:
62+
Once set up, you can install Zipline from our ``Quantopian`` channel:
5563

5664
::
5765

5866
conda install -c Quantopian zipline
5967

6068
Currently supported platforms include:
6169

62-
- Windows 32-bit (can be 64-bit Windows but has to be 32-bit Anaconda)
63-
70+
- GNU/Linux 64-bit
6471
- OSX 64-bit
6572

66-
- Linux 64-bit
67-
68-
PIP
69-
---
70-
71-
Alternatively you can install Zipline via the more traditional ``pip``
72-
command. Since zipline is pure-python code it should be very easy to
73-
install and set up:
73+
.. note::
7474

75-
::
76-
77-
pip install numpy # Pre-install numpy to handle dependency chain quirk
78-
pip install zipline
79-
80-
If there are problems installing the dependencies or zipline we
81-
recommend installing these packages via some other means. For Windows,
82-
the `Enthought Python
83-
Distribution <http://www.enthought.com/products/epd.php>`__ includes
84-
most of the necessary dependencies. On OSX, the `Scipy
85-
Superpack <http://fonnesbeck.github.com/ScipySuperpack/>`__ works very
86-
well.
75+
Windows may work; however, it is currently untested.
8776

8877
Dependencies
8978
------------
9079

91-
- Python (2.7 or 3.3)
92-
- numpy (>= 1.6.0)
93-
- pandas (>= 0.9.0)
94-
- pytz
95-
- Logbook
96-
- requests
97-
- `python-dateutil <https://pypi.python.org/pypi/python-dateutil>`__
98-
(>= 2.1)
99-
- ta-lib
80+
See our `requirements file
81+
<https://github.com/quantopian/zipline/blob/master/etc/requirements.txt>`__
10082

10183
Quickstart
10284
==========
@@ -108,15 +90,20 @@ The following code implements a simple dual moving average algorithm.
10890

10991
.. code:: python
11092
111-
from zipline.api import order_target, record, symbol, history, add_history
93+
from zipline.api import (
94+
add_history,
95+
history,
96+
order_target,
97+
record,
98+
symbol,
99+
)
112100
113101
114102
def initialize(context):
115103
# Register 2 histories that track daily prices,
116104
# one with a 100 window and one with a 300 day window
117105
add_history(100, '1d', 'price')
118106
add_history(300, '1d', 'price')
119-
120107
context.i = 0
121108
122109

docs/source/whatsnew/0.8.0.txt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Release 0.8.0
22
-------------
33

44
:Release: 0.8.0
5-
:Date: TBD
5+
:Date: November 6, 2015
66

77
Highlights
88
~~~~~~~~~~
@@ -148,7 +148,7 @@ Experimental Features
148148
Experimental features are subject to change.
149149

150150
* Adds new Pipeline API. The pipeline API is a high-level declarative API for
151-
representing trailing window computaions on large datasets (:issue:`630`).
151+
representing trailing window computations on large datasets (:issue:`630`).
152152
* Adds support for futures trading (:issue:`637`).
153153
* Adds Pipeline loader for blaze expressions. This allows users to pull data
154154
from any format blaze understands and use it in the Pipeline
@@ -187,6 +187,3 @@ Documentation
187187
~~~~~~~~~~~~~
188188

189189
* Switched to sphinx for the documentation (:issue:`816`).
190-
191-
Contributors
192-
~~~~~~~~~~~~

0 commit comments

Comments
 (0)