Skip to content

Commit

Permalink
Merge pull request #122 from bashtage/readme
Browse files Browse the repository at this point in the history
DOC: Update readme and binstar
  • Loading branch information
bashtage authored Aug 4, 2016
2 parents 71eaa6a + 91abece commit 658080c
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 13 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
[![Travis Build Status](https://travis-ci.org/bashtage/arch.svg?branch=master)](https://travis-ci.org/bashtage/arch)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/nmt02u7jwcgx7i2x?svg=true)](https://ci.appveyor.com/project/bashtage/arch/branch/master)
[![Coverage Status](https://coveralls.io/repos/bashtage/arch/badge.svg?branch=master)](https://coveralls.io/r/bashtage/arch?branch=master)
[![codecov](https://codecov.io/gh/bashtage/arch/branch/master/graph/badge.svg)](https://codecov.io/gh/bashtage/arch)
[![Code Health](https://landscape.io/github/bashtage/arch/master/landscape.svg?style=flat)](https://landscape.io/github/bashtage/arch/master)
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.15681.svg)](http://dx.doi.org/10.5281/zenodo.15681)

Expand Down Expand Up @@ -36,6 +37,7 @@ contribute:
## Examples

<a name="volatility"/>

### Volatility Modeling

* Mean models
Expand Down Expand Up @@ -70,6 +72,7 @@ res = am.fit()
```

<a name="unit-root"/>

### Unit Root Tests

* Augmented Dickey-Fuller
Expand All @@ -81,6 +84,7 @@ res = am.fit()
See the [unit root testing example notebook](http://nbviewer.ipython.org/github/bashtage/arch/blob/master/examples/unitroot_examples.ipynb) for examples of testing series for unit roots.

<a name="bootstrap"/>

### Bootstrap

* Bootstraps
Expand Down Expand Up @@ -125,6 +129,7 @@ ci = bs.conf_int(sharpe_ratio, 1000, method='percentile')
```

<a name="multiple-comparison"/>

### Multiple Comparison Procedures

* Test of Superior Predictive Ability (SPA), also known as the Reality Check or Bootstrap Data Snooper
Expand All @@ -151,7 +156,7 @@ for examples of the multiple comparison procedures.
### Installing

* Cython (0.20+, if not using --no-binary)
* nose (For tests)
* py.test (For tests)
* sphinx (to build docs)
* sphinx-napoleon (to build docs)

Expand Down
16 changes: 10 additions & 6 deletions building/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
Binstar
=======
Anaconda Cloud
==============

[Binstar](http://binstar.org) is Continuum's solution for binary package distribution. This directory contains the files required for building a binstar package:
[Anaconda Cloud](https://anaconda.org) is Continuum's solution for
binary package distribution. This directory contains the files
required for building a binstar package:

* `meta.yaml` - Information about the package and dependencies
* `bld.bat` - Windows batch file called in the build process
* `build.sh` - Linux/OSX batch file called in the build process

Two other helper files are included to automate building across Python 2.7 and 3.3.
Two other helper files are included to automate building across
Python 2.7 and 3.5.

* `binstar_windows.bat`
* `binstar_linux.sh`

Running either file from arch/binstar will build all three versions and upload them, assuming the account has been authenticated using
Running either file from arch/binstar will build all three versions and
upload them, assuming the account has been authenticated using

```
binstar login
anaconda login
```

Installing from binstar
Expand Down
6 changes: 3 additions & 3 deletions building/binstar_unix.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
cd ..

export VERSION=2.0
export VERSION=3.2
## detect OS
if [ "$(uname)" == "Darwin" ]; then
export OS=osx-64
Expand All @@ -12,8 +12,8 @@ fi
sudo Xvfb :99 -nolisten tcp -fbdir /var/run &

## declare Python and Numpy Versions
declare -a PY_VERSIONS=( "27" "33" "34" )
declare -a NPY_VERSIONS=( "18" "19" )
declare -a PY_VERSIONS=( "27" "35" )
declare -a NPY_VERSIONS=( "110" "111" )

## Loop across Python and Numpy
for PY in "${PY_VERSIONS[@]}"
Expand Down
6 changes: 3 additions & 3 deletions building/binstar_windows.bat
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Setlocal EnableDelayedExpansion
REM Get current directory
SET CURRENT_WORKING_DIR=%~dp0
REM Python and NumPy versions
set VERSION=2.0
set PY_VERSION=27 33 34
set NPY_VERSION=18 19
set VERSION=3.2
set PY_VERSION=27 35
set NPY_VERSION=110 111


(for %%P in (%PY_VERSION%) do (
Expand Down

0 comments on commit 658080c

Please sign in to comment.