Commit graph

36 commits

Author SHA1 Message Date
Joe Jevnik
605dd450ad DOC: document new factors and methods 2020-07-22 20:55:51 -04:00
Joe Jevnik
948fff2938 DOC: document new pipeline methods 2020-07-22 20:55:51 -04:00
Scott Sanderson
b7b4f81bfc DOC: Documentation tweaks. 2019-07-15 18:48:58 -04:00
Scott Sanderson
e491ebef53 ENH: Initial support for international pipelines.
This commit adds initial support for international markets in the Pipeline API
via addition of the concept of "domains".

Significant changes on this branch include:

- Added `zipline.pipeline.domain` and the `Domain` interface.
  - Added several canonical domain definitions:
    - GENERIC
    - US_EQUITIES
    - CA_EQUITIES
    - GB_EQUITIES

- Added `zipline.country` as a place to define canonical country code names.

- Made `PipelineLoader` an interface and added new `domain` parameter to
  signature of `load_adjusted_array`.

- Added a new system for "generic" and "specialized" DataSet and BoundColumn
  objects.

- Added a new system for inferring a domain from a pipeline that contains a mix
  of generic and non-generic terms.

- Reworked the built-in pricing dataset. USEquityPricing dataset is now a
  specialized version of a generic EquityPricing dataset, and most built-in
  factors are now implemented in terms of EquityPricing rather than
  USEquityPricing.

- Removed `zipline.data.us_equity_pricing`.
  - Moved BcolzDailyBar{Reader,Writer} to `zipline.data.bcolz_daily_bars`.
  - Moved SQLiteAdjustment{Reader,Writer} to `zipline.data.adjustments`.

New dependencies added as part of this work:

- iso3166 (for canonical country code definitions)
- python-interface (for strict interface definitions).

See https://github.com/quantopian/zipline/issues/2265 for a full description of
the design for domains.
2018-09-10 10:05:39 -05:00
Scott Sanderson
b22bd4c2d6 DOC: More doc updates. 2018-07-16 17:46:15 -04:00
Scott Sanderson
108c80f710 DOC: Add docs entry for pipeline datasets. 2018-07-16 17:46:15 -04:00
Scott Sanderson
da8583a056 DOC: Update docs. 2018-07-16 17:46:15 -04:00
Scott Sanderson
39ed800703 DOC: Add whatsnew for 1.3.0. 2018-07-16 17:46:15 -04:00
Joe Jevnik
1f50b1b0d3 ENH: new risk metrics API 2018-02-26 17:48:14 -05:00
Ana Ruelas
5dec3b77c1 EHH: New filter AllPresent with tests
DOCS: Include built-in filters section in user documentation
2017-10-10 11:46:58 -04:00
Richard Frank
9f9bbb99e6 DOC: Removed yahoo_equities autodoc. Code was removed. 2017-09-12 17:33:48 -04:00
Ana Ruelas
b7a3f43437 DOC: Include MACDSignal in zipline.io documentation 2017-06-06 13:46:06 -04:00
Ana Ruelas
bb74a0e994 DOC: Include pipeline Term in documentations 2017-06-05 16:11:19 -04:00
Ana Ruelas
a1fb90db03 DOC: Include all Factor methods in documentation 2017-06-05 16:10:47 -04:00
Ana Ruelas
846744214f DOC: Include PipelineEngine in documentation 2017-06-05 16:09:36 -04:00
Ana Ruelas
82ebbfa18c DOC: Removed non-existent classes from docs 2017-06-05 16:08:21 -04:00
Ana Ruelas
2178ad1081 DOC: Create built in factors subheading, organize them alphabetically 2017-06-05 16:00:09 -04:00
Eddie Hebert
f4daf10e2f MAINT: Remove future_chain API method.
`future_chain` will be replaced by the as yet to be implemented method,
`data.current_chain`

Also removing `FutureChain` which will be replaced by another version
which only supports indexing and iteration.
2016-09-21 11:08:34 -04:00
Andrew Daniels
440806ad60 MAINT: Use TradingCalendar objects for bundles (#1397)
* MAINT: Use TradingCalendar objects for bundles

Instead of trading days, opens, and closes, register now takes a
TradingCalendar object, along with a start_session and end_session. The
ingest function is now passed these values instead as well.

* Accept calendar name in addition to the actual object

* Updates bundles documentation for changes

* Fix typo in docs

* Use class formatting

* Force start_session and end_session within the bounds of the calendar

* Use UTC timestamps in test_core

* Document Trading Calendar API in appendix.rst
2016-08-17 13:37:07 -04:00
Scott Sanderson
24f30803bd REL: 1.0.1.
Update docs, whatsnew, and stub files for the release.
2016-05-27 16:41:47 -04:00
dmichalowicz
1ec0bced6d ENH: Add builtin factors for correlation and regression 2016-05-18 15:11:12 -04:00
Jean Bredeche
6b1cdb6929 DOC: Updated whatsnew with Q2 information. 2016-05-13 16:48:57 -04:00
Joe Jevnik
784d5f4a16 Merge pull request #1199 from quantopian/boybands-factor
BollingerBands factor
2016-05-13 15:35:10 -04:00
Joe Jevnik
2297ace20c ENH: Adds BollingerBands factor. 2016-05-11 21:41:55 -04:00
Joe Jevnik
d888c4faaa DOC: update docs for api functions 2016-05-06 15:25:30 -04:00
Joe Jevnik
59c8e371a2 ENH: Updates the cli, data bundles and extensions.
Adds the data bundle concept which makes it easy for users to register
loading functions to build out minute and daily data along with an
assets db and adjustments db. By default we have provided a `quandl`
bundle which pulls from the public domain WIKI dataset. Users may
register new bundles by decorating an ingest function with
`zipline.data.bundles.register(<name>)`. This also provides a
`yahoo_equities` function for creating an ingestion function that will
load a static set of assets from yahoo.

The cli is now structured as a couple of subcommands and has been
changed to `python -m zipline`. The old behavior of `run_algo.py` has
been moved to the `run` subcommand. This is almost entirely the same
except that it now takes the name of the data bundle to use, defaulting
to `quandl`.

The next subcommand is `ingest` which takes the name of
a data bundle to ingest. This will run the loading machinery and write
the data to a specified location that `run` can find.

There is also a `clean` subcommand which deletes the data that was
written with `ingest`.

Extensions have also been added to zipline. This is an experimental
feature where users can provide an extra set of python files to run at
the start of the process. These can be used to configure aspects of
zipline. Right now the only thing that is supported in an extension file
is the registration of a new data bundle.
2016-05-03 18:38:24 -04:00
Joe Jevnik
7b2e646458 STY: correct underline length 2016-02-23 17:09:18 -05:00
Eddie Hebert
d5c3b5a15c ENH: Add writer for minute bcolz format.
Implement a writer for minute data into a format comprised of multiple
ctables, one for each individual asset, with a common 'index' shared by
all ctables where a given a dt maps to the same array index for all
equities and fields.

This format is pulled from the lazy-mainline/Q2.0 branch, with some
changes to the interface.

Add basic retrieval of values at a given dt to reader. Not yet used by
Zipline simulations, but added to support unit tests.

Also, rename stubbed out us_equity_minutes to minute_bars, since the
writer can be agnostic to asset type.
2016-01-21 10:54:27 -05:00
Scott Sanderson
72887f0065 ENH: Change DollarVolume to AverageDollarVolume. 2015-12-28 16:12:11 -05:00
Scott Sanderson
8abef95bb5 DOC: Rename exponential stddev.
ExponentialWeightedStandardDeviation -> ExponentialWeightedMovingStdDev.

This is more consistent with the other moving moment factors.
2015-12-18 14:30:28 -05:00
Scott Sanderson
7305f0c3b9 DOC: Miscellaneous docs updates. 2015-12-11 22:29:41 -05:00
Scott Sanderson
b5d3f2be0a DOC: Update whatsnew. 2015-12-11 13:54:57 -05:00
Tim Shawver
d576a9dd3a Add the built-in factors to the API docs for zipline.io, so that I can link to the Returns factor from the release notes. 2015-12-01 15:54:19 -05:00
Scott Sanderson
b71327d694 STY: Oxford comma. 2015-11-19 00:46:41 -05:00
Scott Sanderson
1524944edd DOC: Many docs improvements.
- Generate links to sourcecode via the Sphinx `viewcode` extension.
- Generate reference docs for Asset/Equity/Future, AssetFinder, and
  AssetDBWriter.
- Generate reference docs for Pipeline API classes.
- Fix broken links and formatting issues in the 0.8.4 whatsnew.
- Use embedsignature in _assets.pyx so that the signatures of Asset
  subclasses are inspectable.
2015-11-19 00:15:17 -05:00
llllllllll
39a4cf0a9e DOC: use sphinx docs 2015-11-06 15:10:34 -05:00